Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add XElement to data available for XML comments #728

Merged
merged 2 commits into from
Nov 10, 2021
Merged

Conversation

dsyme
Copy link
Contributor

@dsyme dsyme commented Nov 10, 2021

No description provided.

@dsyme
Copy link
Contributor Author

dsyme commented Nov 10, 2021

@MangelMaxime Can you check his fixes #710 for you?

@dsyme dsyme merged commit 8b5c092 into fsprojects:main Nov 10, 2021
@MangelMaxime
Copy link

I think this will gives me enough information to format the comments.

There is just one strange thing, which is that the content coming from this fix and the one from the XML file generated when compiling a library is not exactly the same.

From this fix:

<member name="P:Nacara.Core.Types.Partial.Id">
  <summary>
 Unique name of the partial, it is generated from the partial file name.

 <example>
 With the following directory structure,

 <code>
 docs
 ├── index.md
 └── _partials
     ├── dropdown
         └── api.jsx
     └── footer.jsx
 </code>

 There are 2 partials:
 - <c>dropdown/api</c>
 - <c>footer</c></example></summary>
</member>

From XML files:

<member name="P:Nacara.Core.Types.Partial.Id">
 <summary>
 Unique name of the partial, it is generated from the partial file name.

 <example>
 With the following directory structure,

 <code>
 docs
 ├── index.md
 └── _partials
     ├── dropdown
         └── api.jsx
     └── footer.jsx
 </code>

 There are 2 partials:
 - <c>dropdown/api</c>
 - <c>footer</c>

 </example>
 </summary>
</member>
  1. <summary> is placed after 2 spaces in one case an 1 in the other.

I think I can adapt my code to adapt to this difference. Hopefully, it doesn't prevent me from generating valid markdown.

Markdown is white-space sensitive, so I am "detection" the unwanted leading white-spaces of the lines and removing them.

  1. The end of the XML seems to be collapsed:
 - <c>footer</c></example></summary>

versus

 There are 2 partials:
 - <c>dropdown/api</c>
 - <c>footer</c>

 </example>
 </summary>

This one seems inoffensive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants