-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update xml-documentation.md #20645
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
Update xml-documentation.md #20645
Conversation
|
There are also detailed-message pages started in the docs/fsharp/language-reference/compiler-messages directory of this repo that tooling can use to provide examples for specific warning and errors. Would it make sense to progressively add to those in situations like this where new messages are added? |
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Phillip Carter <[email protected]>
Co-authored-by: Youssef Victor <[email protected]>
Co-authored-by: Youssef Victor <[email protected]>
Co-authored-by: Youssef Victor <[email protected]>
I personally think we should move to a content driven approach for these, where FSComp.txt contains the detailed explanations, so they are authored and correlated in-repo Though if opinion differs or this is too hard then I guess we can do it by hand, or at least register these as a backlog for that doc debt |
|
All review comments incorporated thanks |
cartermp
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this looks good
Summary
Give more precise information on XML doc comments and include information from dotnet/fsharp#10118
Some of the text is taken form the C# documentation comment pages
cc @cartermp