Skip to content

Commit

Permalink
jsdoc style guide update (#1932)
Browse files Browse the repository at this point in the history
  • Loading branch information
zekth authored and ry committed Mar 15, 2019
1 parent 4dbc33c commit b2f15cf
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion website/style_guide.md
Expand Up @@ -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 strongly typed.

```ts
/**
* Function with non obvious param
* @param foo Description of non obvious parameter
*/
```

Vertical spacing should be minimized whenever possible. Therefore single line
comments should be written as:
Expand Down

0 comments on commit b2f15cf

Please sign in to comment.