Consider adding JSDoc to utility functions in mantine. #604
UltraInstinct05
started this conversation in
Feedback
Replies: 1 comment 1 reply
-
These functions are very basic, I think that variables name are descriptive enough |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Mantine
has a good number of utility functions and hooks, which lack proper documentation comments. These comments are useful because the IDE/text editor (which has properLSP
support) can parse them and show such documentation in hover popups, which adds a lot of value.E.g. I am taking Sublime Text as an example with the
LSP
&LSP-typescript
installed (Should be similar in VS Code)Hovering over
lighten
(which does not have a documentation comment by default)Hovering over
lighten
(which has a documentation comment)Beta Was this translation helpful? Give feedback.
All reactions