api-doc-tools

api-doc-tools copied to clipboard

 The `Async` types. This is currently done in the [F# MSDN Reference](https://msdn.microsoft.com/en-us/visualfsharpdocs/conceptual/control.async-class-%5bfsharp%5d)

cartermp

Currently, no members are listed for F# classes. However, in two places this is done: * Tooltips in all F# editors * The existing MSDN reference for FSharp.Core ([example](https://msdn.microsoft.com/en-us/visualfsharpdocs/conceptual/control.async-class-%5bfsharp%5d)) So...

cartermp

F#: Active patterns are not quite represented properly

1

See the smoke test:  vs. the [existing MSDN reference entry](https://msdn.microsoft.com/en-us/visualfsharpdocs/conceptual/exprshape.shapevarhshapelambdahshapecombination-active-pattern-%5bfsharp%5d): 

cartermp

See here:  `Var * Expr` is wrapped in parentheses in F# tooltips in IDEs to help distinguish them from other parameters.

cartermp

From F# smoke test:  Although these are compiled down as such, they are a distinctly different thing from regular functions/methods. This will be very tricky, because [according to SharpLab](https://sharplab.io/#v2:DYLgZgzgPg9gDgUwHYAICyBLAxgJxhGMAFwDoAxAZQAsBDHOEgRQFcYiaiMYkISAFDkQQ4eAWABQEgLYwAJs2AJ0KALwSUGlIqIoAFFACiAN2RQA8rNlQAlCgxI4zHSrtg7DpygCkKAEyqUAAYUIipkFGNwhGAIJQtZdU1EjW09KABJJCEAc2EoAH0bPQgiHBAUEpx7bNs1cU0GrQQdKScaACNFdyIjGmBmJRdA5MaMNwoATxKEKRJMogBmXxIAFRwJgRxY3UqAGhQAMnsevoHbUPCKGCkEXWPe/oRrEYbo2JQAOW4EF80gA),...

cartermp

From FSharp.Core smoke test:  In source, these are all camelCase. And in the type signature, the correct casing is applied: 

cartermp

Current list: * ByRefKinds * ByRefKinds.In * ByRefKinds.InOut * ByRefKinds.Out

cartermp

See current [MSDN entry](https://msdn.microsoft.com/en-us/visualfsharpdocs/conceptual/map.oflist%5b'key,'t%5d-function-%5bfsharp%5d):  Compared with FSharp.Core smoke test: 

cartermp

From FSharp.Core smoke test:  `Microsoft.FSharp.Collections.` is unnecessary here.

cartermp

From FSharp.Core smoke test:  `MapModule` should be `Map`.

cartermp