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

[wip] support for all recommended xml tags #331

Merged
merged 12 commits into from
Dec 17, 2015
Merged

Conversation

ademar
Copy link
Contributor

@ademar ademar commented Jul 21, 2015

The purpose of this PR is to bring support for all recommended tags (ref #295)

https://msdn.microsoft.com/en-us/library/vstudio/5ast78ax(v=vs.100).aspx

TODO: unit tests

@tpetricek
Copy link
Member

Very cool, it will be great to have this!

@matthid
Copy link
Member

matthid commented Sep 20, 2015

Yeah I think this is very useful, thanks! Can you rebase your changes against the latest changes (ideally against the fix_extension_methods branch)?

@ademar ademar mentioned this pull request Nov 5, 2015
@ademar
Copy link
Contributor Author

ademar commented Nov 26, 2015

Guys, I have rebased this PR against master.

I have disabled this test 4f4c3c2

In our use case, markDownComments = false, we want to render all comments regardless of whether or not they are enclosed by XML tags.

It would be nice if this gets merged, I could use it over here SuaveIO/suave#239

@matthid
Copy link
Member

matthid commented Nov 30, 2015

There are multiple reasons why I think we should support special commands, even when markDownComments = false:

  • It should be as simple as for the markdown case to exclude some comments from the website (while still having them in the IDE).
  • Problem is that sometimes FSharp.Compiler.Service throws errors on some language constructs, and [omit] is an easy workaround for such cases.

So it was definitely "by-design" that I called https://github.com/tpetricek/FSharp.Formatting/pull/331/files#diff-e2212151e1f9b6e7e085820d2a6b71caL652 (findCommands) in both cases.

@matthid
Copy link
Member

matthid commented Nov 30, 2015

@tpetricek What do you think?

The discussion is about using

/// [omit]

in case of markDownComments = false, where we ignore other markdown constructs.

@ademar
Copy link
Contributor Author

ademar commented Nov 30, 2015

@matthid Sorry, I now realize I did not understood correctly the purpose of findCommand and [omit]. Let me correct that.

matthid added a commit that referenced this pull request Dec 17, 2015
[wip] support for all recommended xml tags
@matthid matthid merged commit 4f737d1 into fsprojects:master Dec 17, 2015
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.

3 participants