summaryrefslogtreecommitdiff
path: root/website
diff options
context:
space:
mode:
authorVincent LE GOFF <g_n_s@hotmail.fr>2019-03-15 16:53:21 +0100
committerRyan Dahl <ry@tinyclouds.org>2019-03-15 11:53:21 -0400
commitb2f15cf21ae7b08986468dd8d18b06f9c2e97dc2 (patch)
treebb983c76990a14dc78d580a36b2438a4aedebc9b /website
parent4dbc33c6e3824bc56c884a58a8cfd814e266257d (diff)
jsdoc style guide update (#1932)
Diffstat (limited to 'website')
-rw-r--r--website/style_guide.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/website/style_guide.md b/website/style_guide.md
index bb0a643ef..c2ed2c483 100644
--- a/website/style_guide.md
+++ b/website/style_guide.md
@@ -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: