Enhancement: reduce errors generated from JSDoc expectations #79
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks @igneel64 ! Maybe we can add eslint-plugin-jsdoc to enforce jsdoc consistency. What do you think about it ? |
|
@danivek Happy to contribute! I will add the plugin, make the required changes and come back to you. |
|
@danivek Ready for your review. |
|
Wow, I would not have been so far on adding jsdoc when it was missing. 👍 Big thanks ! @igneel64 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current state:
Currently some minor typos etc are generating couple of warnings/errors when checking compliance with JSDoc.
Changes introduced:
Fix documentation for function definitions that would generate these errors.