search

fslaborg / flips

Fsharp LInear Programming System
https://flipslibrary.com/#/
MIT License
253 stars 32 forks source link

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

Closed baronfel closed 3 years ago

baronfel commented 3 years ago

While working on https://github.com/dotnet/fsharp/pull/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 commented 3 years ago

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 commented 3 years ago

@baronfel Thanks! This is now merged