misc: use jsdoc-style comments on Flags properties #7359
Merged
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
exterkamp
reviewed
Mar 2, 2019
| lanternDataOutputPath?: string; | ||
|
|
||
| // The following are given defaults in cli-flags, so are not optional like in Flags or SharedFlagsSettings. |
There was a problem hiding this comment.
Should this also be /** */?
Or is it just // b/c it is a comment instead of an annotation for a single field?
There was a problem hiding this comment.
Or is it just // b/c it is a comment instead of an annotation for a single field?
exactly. It's an explanation for why the properties below that point are different (those three properties also have doc strings from their base definitions in SharedFlagsSettings and Flags)
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.
converts them to
/** */style so they appear on hover in vscode, etc