FsAutoComplete icon indicating copy to clipboard operation
FsAutoComplete copied to clipboard

TipFormatter: Backtick should be escaped from cref attributes

Open MangelMaxime opened this issue 3 years ago • 3 comments

The following doc comment

/// See <see cref="T:Fable.Form.Simple.Form.MapValuesConfig`2"/> for more informations

results in:

image

MangelMaxime avatar Apr 28 '21 19:04 MangelMaxime

This might just go away when the next FCS comes out and we get the XML parsing newly-included in there for free.

baronfel avatar Apr 28 '21 21:04 baronfel

Didn't know that, I though I would jump back into the implementation I contributed of TipFormatter but that's good news if there is a standard parser coming out.

Is there a place where I can read about it? Current implementation of the TipFormatter in FSAC is one of the best existing from what I saw in other IDE.

MangelMaxime avatar Apr 29 '21 05:04 MangelMaxime

There's not documentation yet, but this PR was merged a little bit ago and will be coming in FCS 40.

Essentially it would remove/replace our built-in XML comment reading with a facility that is in FCS now, but the extraction of information that TipFormatter uses to collect into the tooltips would likely remain the same. Just the data structure that the information would be extracted from would change.

baronfel avatar Apr 30 '21 15:04 baronfel