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] improve xml doc comments for FSharp.Core #9837

Closed
wants to merge 5 commits into from
Closed

Conversation

dsyme
Copy link
Contributor

@dsyme dsyme commented Jul 30, 2020

There is an F# community effort going on to properly generate the FSharp.Core API docs using the fsdocs tooling, see

As part of this we will need to cleanup our XML doc in the original FSharp.Core source.

This PR will contain a bunch of improvements in this regard

  1. Add spacing between summary, param, exception, returns and remarks sections so it's much easier to visuall see what's what in the documentation. (currently it is hard to review and read in the source itself because it is cramped)

  2. Use <see cref="..."> more systematically - we already use this in seq.fsi so there is nothing new here, but this correctly adds the T: , P: and M: tags to the references.

  3. Remove a massive remarks section for the Printf module which is really written documentation, and has been transferred into the F# docs here: F# plaintext printing documentation docs#19632

See also #9805 which deals with possible improvements to the docs story where the compiler checks the docs including symbol references.

I'll push in more improvements today/tomorrow

@dsyme dsyme changed the title [WIP] improve xml doc cpmments for FSharp.Core [WIP] improve xml doc comments for FSharp.Core Jul 31, 2020
@dsyme dsyme closed this Jul 31, 2020
@dsyme
Copy link
Contributor Author

dsyme commented Jul 31, 2020

Continued in #9844

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.

1 participant