diff options
| author | Domingo2000 <[email protected]> | 2022-10-14 19:45:05 -0300 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-10-14 22:45:05 +0000 |
| commit | d3fb2c0e0324740eccab6c8249f6c809a5681b53 (patch) | |
| tree | b5455cc067ce1b4608503c63f3c5920a55324444 | |
| parent | 476533697141f0e88c9eca300d0b5040dd8a09d7 (diff) | |
| download | faker-d3fb2c0e0324740eccab6c8249f6c809a5681b53.tar.xz faker-d3fb2c0e0324740eccab6c8249f6c809a5681b53.zip | |
docs: fix CONTRIBUTING.md JSDoc do/dont (#1450)
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a28588b1..7566476e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -321,9 +321,11 @@ This rule improves the comments readability by grouping equivalent tags and maki ```ts /** - * This is a bad JSDoc block, because it has no linebreaks between sections. + * This is a good JSDoc block, because it follows the Faker preferences. + * * @param bar The first argument. * @param baz The second argument. + * * @example foo(1, 1) // [1, 1] * @example foo(13, 56) // [13, 56] */ @@ -337,11 +339,9 @@ function foo(bar: number, baz: number): [number, number] { ```ts /** - * This is a good JSDoc block, because it follows the Faker preferences. - * + * This is a bad JSDoc block, because it has no linebreaks between sections. * @param bar The first argument. * @param baz The second argument. - * * @example foo(1, 1) // [1, 1] * @example foo(13, 56) // [13, 56] */ |