Info Panel enhancements

[baronfel]

In some code I was looking at today, I noticed that the Info Panel had a couple gaps. I thought it might be nice to have a discussion thread where we could centralize discussion about enhancements to the feature.

[baronfel]

Show XML documentation for Functions and Fields on a Record

Currently, the Info Panel doesn't show XML Docs for Functions/Fields/etc of a Record type (and probably other types).

[MangelMaxime]

It is funny because I was going to report some issues about it ^^.

InfoPanel doesn't show the comment on type alias.

It seems like it displays the attributes/fields from the aliased type but not the documentation about it.

I think type alias should show the top most documentation.

module Child =

    /// <summary>
    /// Deepest documentation
    /// </summary>
    type User =
        {
            Name : string
        }

type MyUser = Child.User

Should show Deepest documentation

module Child =

    /// <summary>
    /// Deepest documentation
    /// </summary>
    type User =
        {
            Name : string
        }

/// <summary>
/// Top most documentation
/// </summary>
type MyUser = Child.User

Should show Top most documentation

[baronfel]

I don't think that Type Abbreviations (what type aliases are called in the SyntaxTree) can have xml comments:

    | TypeAbbrev of
        detail: ParserDetail *
        rhsType: SynType *
        range: range

so your last example can't be done because of the AST.

[MangelMaxime]

I trust you on that point, I don't know much of the AST.

I just thought about that because at least on the declaration side Ionide is able to show the tooltip but perhaps the resolution is different as it is in the source file directly.

[MangelMaxime]

When working on FSAC TipFormatter I added lang support for code tag.

It make nicer code samples in the tooltips:

/// <summary>
/// Some documentation
/// </summary>
/// <example>
/// <code lang="fsharp">
/// // Some comment to show coloration
/// let add (x : int) (y : int) = x + y
/// </code>
/// </example>
let myFunc x =  ()

However, the info panel isn't processed the same way by VSCode.

I am not sure if we can use Onigurama (the textmate grammar parser) from a VSCode extension. If we can, we could re-use Code-Lightner which I use to highlights code snippets in different project.

Or at minima we could use something like Highlight JS

[MangelMaxime]

The highlighting could be applied to the signature section too.

[MangelMaxime]

PS: I am throwing ideas but I don't guarantee that they are all good/doable. But if I don't propose them, they will probably never be implemented at least like that they have a chance to be ^^

When writing doc comment it is hard to see how it will looks like.

It could be nice to be able to make the info panel update on content change. So we could visualise the result of the doc comment result "in real time".

Currently we have the following option to control info panel update:

When setting onCursorMove it does update the info panel when editing at certain place.

I suspect (didn't look at the code) that the info panel is not being updated when editing a doc comment because, we are not under a symbol or keyword and so it is filtered out.

If that's the case, we could detect when we are editing a doc comment and re-ask for the same info panel as the last call. Or for the info panel associated to the type being documented if we can detect it.