docs(contributing): reword JSDocs empty line example

Co-authored-by: Shinigami <chrissi92@hotmail.de> docs(contributing): reword JSDocs empty line example Co-authored-by: Shinigami <chrissi92@hotmail.de>
faker-js · Jun 26, 2022 · ce89a51 · ce89a51
1 parent 87f2127
commit ce89a51
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -165,7 +165,7 @@ This rule ensures a minimal grammatically correctness in the comments and ensure
 
 ```ts
 /**
- * This is a good JSDoc description.
+ * This is a bad JSDoc block, because it has no linebreaks between sections.
  * @param a The first summand.
  * @param b The second summand.
  * @example sum(1, 1) // 2
@@ -181,7 +181,7 @@ function sum(a: number, b: number): string {
 
 ```ts
 /**
- * This is a good JSDoc description.
+ * This is a good JSDoc block, because it follows the Faker preferences.
  *
  * @param a The first summand.
  * @param b The second summand.