Skip to content

Commit d3fb2c0

Browse files
authored
docs: fix CONTRIBUTING.md JSDoc do/dont (#1450)
1 parent 4765336 commit d3fb2c0

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -321,9 +321,11 @@ This rule improves the comments readability by grouping equivalent tags and maki
321321

322322
```ts
323323
/**
324-
* This is a bad JSDoc block, because it has no linebreaks between sections.
324+
* This is a good JSDoc block, because it follows the Faker preferences.
325+
*
325326
* @param bar The first argument.
326327
* @param baz The second argument.
328+
*
327329
* @example foo(1, 1) // [1, 1]
328330
* @example foo(13, 56) // [13, 56]
329331
*/
@@ -337,11 +339,9 @@ function foo(bar: number, baz: number): [number, number] {
337339

338340
```ts
339341
/**
340-
* This is a good JSDoc block, because it follows the Faker preferences.
341-
*
342+
* This is a bad JSDoc block, because it has no linebreaks between sections.
342343
* @param bar The first argument.
343344
* @param baz The second argument.
344-
*
345345
* @example foo(1, 1) // [1, 1]
346346
* @example foo(13, 56) // [13, 56]
347347
*/

0 commit comments

Comments
 (0)