Fix JSDoc comments for @param tags so that there is a hypen before description #6634
Conversation
This file contains 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
…n b/w the closing bracket and the description. NOTE: I used this (@param)( )+\{([^}])+\}( )+(\[([\S ])+\]( )+)?\w+([ ])+[ \w] to search for em.
Codecov Report
@@ Coverage Diff @@
## dev #6634 +/- ##
=======================================
Coverage 82.34% 82.34%
=======================================
Files 37 37
Lines 1897 1897
=======================================
Hits 1562 1562
Misses 335 335
Continue to review full report at Codecov.
|
bigtimebuddy
approved these changes
May 19, 2020
|
Not sure what's up with the GitHub Actions. 🤷♂️ |
themoonrat
approved these changes
May 20, 2020
bigtimebuddy
added
the
✅ Ready To Merge
|
Thanks @SukantPal! |
3 tasks
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.
Our code had a lot of
documentations. However, there should be a hyphen before the description (see https://github.com/microsoft/tsdoc & open the TSDoc playground and try removing the hyphen, a warning will be logged).
I wanted to do this change so that webdoc would stop logging warnings. Also, @bigtimebuddy said that we should follow the TSDoc standard.
Description of change
I used
/(@param)( )+\{([^}])+\}( )+(\[([\S ])+\]( )+)?\w+([ ])+[ \w]/gto find all the instances of these inconsistencies.Reviewers
Make sure I didn't make a change to any code and/or incorrectly changed the docs.
Pre-Merge Checklist
npm run lint)npm run test)