Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Is it possible to add textual details to types definitions? #399

Open
SBoudrias opened this issue Sep 11, 2020 · 1 comment
Open

Is it possible to add textual details to types definitions? #399

SBoudrias opened this issue Sep 11, 2020 · 1 comment

Comments

@SBoudrias
Copy link

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
Copy link
Contributor

orta commented Sep 11, 2020

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants