I have a documented interface that I'm using to type a function's argument. When I start writing the function, the intellisense pops up with the function's documentation, but the interface documenation is hidden behind a link. How can I get the interface docs to correctly display?
#How can I get interface documentation to properly display in VSCode intellisense?
10 messages · Page 1 of 1 (latest)
well you did put it in as a @link
i'm not seeing anything that would inline the entire definition
does it not show WaitForOptions docs if you start typing an object/property?
No, it just shows the same link, and autocomplete for the properties (but no description). If its not possible to inline then I suppose I will either have to accept it or maybe find a workaround. Is there a good workaround solution?
if you start typing property names and then hover over the property name you should at least see the docstring for that property
not sure if you consider that a viable "workaround"
why do you want this? what's wrong with the link?
another probably-obvious-but-unsatisfying workaround is to apply some build-time preprocessing that copy/pastes the docstring to inline it (or just do that manually yourself if it isn't expected to change often)
Yes that does work, thanks for the tip