More JSdoc #120
MarlonPassos-git
started this conversation in
Ideas
More JSdoc
#120
Replies: 1 comment
-
I'm a big fan of better docs and DX. If there's anyway I can help let me know :) |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
one thing I really like about the new code editors is when hovering over the function it shows a lot of useful information about the current function.
In my mind it would be really cool to add a link to the documentation and at least one example along with the function.
of course this would have the effect of augmenting the file a little with jsdoc, but it would make everything more documented
If I find something valid I can be making a pr by adding both @link and @example
then you would have to know which phrase to use to indicate documentation
Beta Was this translation helpful? Give feedback.
All reactions