docs: update contributing guidelines

ST-DDT · ST-DDT · commit 0ef77594e066 · 2023-03-22T23:15:58.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -167,7 +167,7 @@ Example:
 /**
  * @see faker.cat.random()
  *
- * @deprecated Use faker.cat.random() instead.
+ * @deprecated Use `faker.cat.random()` instead.
  */
 get cat() {
   deprecated({
@@ -216,7 +216,7 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
  *
  * @since 7.5.0
  *
- * @deprecated Use faker.cat.random() instead.
+ * @deprecated Use `faker.cat.random()` instead.
  */
 function foo(options: { test: string } = {}): string {
   // implementation

Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ Example:`
`167`	`167`	`/**`
`168`	`168`	`* @see faker.cat.random()`
`169`	`169`	`*`
`170`		`- * @deprecated Use faker.cat.random() instead.`
	`170`	+ * @deprecated Use `faker.cat.random()` instead.
`171`	`171`	`*/`
`172`	`172`	`get cat() {`
`173`	`173`	`deprecated({`
@@ -216,7 +216,7 @@ JSDoc will be read and automatically processed by `generate:api-docs` and theref
`216`	`216`	`*`
`217`	`217`	`* @since 7.5.0`
`218`	`218`	`*`
`219`		`- * @deprecated Use faker.cat.random() instead.`
	`219`	+ * @deprecated Use `faker.cat.random()` instead.
`220`	`220`	`*/`
`221`	`221`	`function foo(options: { test: string } = {}): string {`
`222`	`222`	`// implementation`