improve doc comments for FSharp.Core #9844
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continues the work of #9837 in a feature branch
There is an F# community effort going on to properly generate the FSharp.Core API docs using the
fsdocs
tooling, seeAs 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. I propose that doc improvements get pushed into
feature/docs
and we integrate them from time to time. Then for now the community docs for FSharp.Core can be built from fsharp/docs.This batch of work includes:
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)
Use
<see cref="...">
more systematically - we already use this inseq.fsi
so there is nothing new here, but this correctly adds theT:
,P:
andM:
tags to the references.Remove a massive
remarks
section for thePrintf
module which is really written documentation, and has been transferred into the F# docs here: F# plaintext printing documentation docs#19632See also #9805 which deals with possible improvements to the docs story where the compiler checks the docs including symbol references.