flow/flow-for-vscode

Is it possible to add textual details to types definitions?

SBoudrias opened this issue · 1 comments

Hi, I wasn't sure where to ask this question - hopefully doing it here is fine.

I was wondering if the flow plugin for vscode would allow adding textual/free text details to type annotations.

Currently, the editor only displays the type definition, but sometime these types would look better if they were accompanied of a free text description explaining for example what a given argument is for.

Screen Shot 2020-09-10 at 5 21 14 PM

For example, when there's string types. It's often not super clear how those will be used. So some manually written documentation could go a long way in helping the users of our library gather all the details automatically inside the editor.

orta commented

This info may be available to request now: facebook/flow#2956