docs: apply feedback

ST-DDT · ST-DDT · commit 19d803bccf23 · 2022-02-01T19:38:30.000+01:00
diff --git a/src/name.ts b/src/name.ts
@@ -214,11 +214,11 @@ export class Name {
   }
 
   /**
-   * Return a random gender name.
+   * Return a random gender.
    *
    * @example
-   * faker.name.jobTitle() // 'Trans*Man'
-   * faker.name.jobTitle(true) // 'Female'
+   * faker.name.gender() // 'Trans*Man'
+   * faker.name.gender(true) // 'Female'
    *
    * @param binary Whether to return only binary gender names. Defaults to false.
    */

Original file line number	Diff line number	Diff line change
`@@ -214,11 +214,11 @@ export class Name {`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`/**`
`217`		`- * Return a random gender name.`
	`217`	`+ * Return a random gender.`
`218`	`218`	`*`
`219`	`219`	`* @example`
`220`		`- * faker.name.jobTitle() // 'Trans*Man'`
`221`		`- * faker.name.jobTitle(true) // 'Female'`
	`220`	`+ * faker.name.gender() // 'Trans*Man'`
	`221`	`+ * faker.name.gender(true) // 'Female'`
`222`	`222`	`*`
`223`	`223`	`* @param binary Whether to return only binary gender names. Defaults to false.`
`224`	`224`	`*/`