Skip to content

Conversation

@dsyme
Copy link
Contributor

@dsyme dsyme commented Sep 15, 2020

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

@baronfel
Copy link
Member

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?

@dsyme
Copy link
Contributor Author

dsyme commented Sep 15, 2020

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?

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

@dsyme
Copy link
Contributor Author

dsyme commented Sep 15, 2020

All review comments incorporated thanks

Copy link
Contributor

@cartermp cartermp left a 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

@cartermp cartermp merged commit 1acf542 into dotnet:master Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants