Documentation for the default constructor about fsharp.formatting HOT 10 CLOSED

If it's not possible (which is ok) then FSharp.Formatting should propose a way to fill the gap with the docs on the type itself.

from fsharp.formatting.

The F# compiler does not support commenting the default constructor. Handling this in F# Formatting is a great idea. Do you have any preference on how to write this? Perhaps something like:

/// Type comment
///
/// [constructor]
/// Constructor comment
///
/// ## Parameters
///  - `foo` means nothing
type Bar(foo:int) = (..)

from fsharp.formatting.

No please don't add such magic to it. [omit] should be enough magic.

Have to think about it. We should defer this.

from fsharp.formatting.

That's why I'm looking for better ideas :-) better ideas on [omit] are also welcome...

from fsharp.formatting.

There is another "issue".

I like to have a detailed information about a module like this:

but I don't want to see all details in the module overview:

I assume this can also be done via magic, but...

/cc @Slesa

from fsharp.formatting.

I wrote that in the comments, just to have the information there. But it'd be better a part of the tutorial.

from fsharp.formatting.

Yep maybe, but there are a couple of other helpers where I have the same "problem".

from fsharp.formatting.

Well, another "magic" is that for the overview, it only picks all content until the first heading. So:

/// Summary
///
/// ## Details
/// More info
module Foo = (...)

... should do the trick. Again, I did this just while I was experimenting with the options. Better suggestions are welcome :-)

The problem is that we generally have to put everything in /// comments - perhaps cross-reference to some other file might work... but that does not feel any simpler.

from fsharp.formatting.

works like a charm.

from fsharp.formatting.

Closing this old issue (spring cleaning)

from fsharp.formatting.