[No QA] Improve guidance for JSDocs#7177
Merged
Merged
Conversation
thienlnam
previously approved these changes
Jan 12, 2022
thienlnam
left a comment
Contributor
There was a problem hiding this comment.
LGTM
NAB: Might be easier to read if the Do Nots and the Dos are grouped together
Contributor
Author
|
Ah good call. I created some separation between them and listed the "dos" before the "donts". |
thienlnam
approved these changes
Jan 12, 2022
Contributor
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
66 tasks
Contributor
|
🚀 Deployed to staging by @marcaaron in version: 1.1.29-6 🚀
|
Contributor
|
🚀 Deployed to production by @roryabraham in version: 1.1.30-3 🚀
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Details
There are some pretty inconsistent usages of JSDocs happening in the codebase. I tried to write them down here so they are easier to enforce in general. Many of these rules are things that we are implicitly asking for and on an inconsistent basis. There is no way to know we want them done this way so nobody can be expected to do it.
Fixed Issues
❌
Tests
❌