Query docs for custom operators don't mention they are custom operators

fsharp / fsharp-core-docs

Generated API documentation for the FSharp.Core library. Generated using FSharp.Formatting.

http://fsharp.github.io/fsharp-core-docs

MIT License

34 stars 19 forks source link

Open dsyme opened 4 years ago

dsyme commented 4 years ago

The query docs for each custom operator need a remarks section (or a mention in the summary) about how the custom opreator is used

At the moment there's no mention of the custom operator, and the usage text looks like a method call.

Two sides to this

partly an FSharp.Core.xml problem (doc comment needs to mention this)
partly an F#F problem (adjust usage text to show both method call and builder syntax)

dsyme commented 4 years ago

@Krzysztof-Cieslak presumably these kind of fixes are also necessary for Saturn docs