Update xml-documentation.md - #20645

Merged

cartermp merged 15 commits into

dotnet:masterfrom

Sep 15, 2020

dsyme commented Sep 15, 2020•
edited
Loading

Contributor

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

Update xml-documentation.md

8f89401

dsyme requested a review from cartermp as a code owner

September 15, 2020 13:06

dotnet-bot added this to the September 2020 milestone

dotnet-bot added the 📚 Area - F# Guide label

dsyme mentioned this pull request

Check XML doc parameter names for FSharp.Core via opt-in checking dotnet/fsharp#10118

Merged

dsyme added 2 commits

September 15, 2020 14:15

Update xml-documentation.md

b6580ea

Update xml-documentation.md

c3aeb19

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

Youssef1313 reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

baronfel commented Sep 15, 2020

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?

cartermp reviewed

View reviewed changes

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

docs/fsharp/language-reference/xml-documentation.md Outdated

dsymeand others added 12 commits

September 15, 2020 18:10

Update docs/fsharp/language-reference/xml-documentation.md

ecf6fc8

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

39f9270

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

68e6da3

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

4c51cea

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

a52495c

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

821be9c

Co-authored-by: Phillip Carter <pcarter@fastmail.com>

Update docs/fsharp/language-reference/xml-documentation.md

2222261

Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com>

Update docs/fsharp/language-reference/xml-documentation.md

93941ba

Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com>

Update docs/fsharp/language-reference/xml-documentation.md

b25c401

Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com>

Update xml-documentation.md

bcc3b9c

Update xml-documentation.md

c41c118

Update xml-documentation.md

5ec4fbc

dsyme commented Sep 15, 2020

ContributorAuthor

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 commented Sep 15, 2020

ContributorAuthor

All review comments incorporated thanks

cartermp approved these changes

View reviewed changes

cartermp left a comment

Contributor

Thanks, this looks good

cartermp merged commit 1acf542 into dotnet:master

BillWagner added dotnet-fsharp/svc and removed 📚 Area - F# Guide labels

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment