Skip to content

Commit 897fd71

Browse files
committed
Fix link to JSDoc in Guidelines documentation
* Adds missing link to usejsdoc.org to JSDoc.
1 parent ef459f2 commit 897fd71

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

GUIDELINES.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ function foo(bar = 'baz') {}
8686

8787
## Code blocks
8888

89-
Whenever writing an `if`/`else` statement, the `else` keyword should directly follow the closing curly brace from the `if` statement. No line break between the closing brace and the keyword should exist.
89+
Whenever writing an `if`/`else` statement, the `else` keyword should directly follow the closing curly brace from the `if` statement. No line break between the closing brace and the keyword should exist.
9090

9191
Also, there should always be a single space between the `if` keyword and the condition.
9292

@@ -104,7 +104,7 @@ Same goes with do/while and try/catch.
104104

105105
## Inline documentation
106106

107-
Every function should be documented using [JSDoc](). Annotations should not be aligned in order not to have to update alignment whever a longer line is added.
107+
Every function should be documented using [JSDoc](http://usejsdoc.org/). Annotations should not be aligned in order not to have to update alignment whever a longer line is added.
108108

109109
```js
110110
/**
@@ -125,7 +125,7 @@ cfg.post(config);
125125
config.view = config; // Backward compatibility.
126126

127127
/**
128-
* This is an extra long comment that does not fit on a single line because it
128+
* This is an extra long comment that does not fit on a single line because it
129129
* is longer than 80 characters. Because of this, it it splitted across several
130130
* lines.
131131
*/

0 commit comments

Comments
 (0)