jsdoc style guide update #1932
Merged
jsdoc style guide update #1932
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
xeqlol
reviewed
Mar 15, 2019
website/style_guide.md
Outdated
| @@ -230,7 +230,15 @@ For example: | |||
|
|
|||
| Do not document function arguments unless they are non-obvious of their intent | |||
| (though if they are non-obvious intent, the API should be considered anyways). | |||
| Therefore `@param` should generally not be used. | |||
| Therefore `@param` should generally not be used. If `@param` is used, it should | |||
| not include the `type` as Typescript is already strong typed. | |||
There was a problem hiding this comment.
It should be "Typescript is already strongly typed."
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.
As discussed in denoland/deno_std#271 (comment)
Jsdoc style guide is updated to tell people to not use the typing in the jsdoc param.
cc @kitsonk