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

document CE constructors in a way that circumvents the warnings #137

Merged
merged 1 commit into from
Dec 29, 2020

Conversation

baronfel
Copy link
Contributor

While working on dotnet/fsharp#10810 to help improve doc comment generation, I found that the compiler wants you as a library author to separate docs for the type from docs for the implicit constructors. This does that, which fixes the documentation warnings.

@baronfel baronfel changed the title document CE constructors iin a way that circumvents the warnings document CE constructors in a way that circumvents the warnings Dec 27, 2020
@baronfel
Copy link
Contributor Author

As an aside, the referenced MR enables support for using named patterns (SOME_THING as NAME) for the XML doc comment parameter names, so we could bring back the previous destructuring that was done on my last PR and add those as names, and get the benefits of both approaches: named parameters as well as concise function bodies

@matthewcrews matthewcrews merged commit 896f4db into fslaborg:main Dec 29, 2020
@matthewcrews
Copy link
Collaborator

@baronfel Thanks! This is now merged

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.

2 participants