aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorHanna <[email protected]>2022-07-19 13:59:58 +0200
committerGitHub <[email protected]>2022-07-19 11:59:58 +0000
commit0bd2f394475a5363f2f0eddc11322c9c6007a5d2 (patch)
tree9b223946b086e16bc6777bed8be92c9ef60371e0 /src/modules
parent0a2ec9d0b957b1f7556a238d3b517fbd586802f4 (diff)
downloadfaker-0bd2f394475a5363f2f0eddc11322c9c6007a5d2.tar.xz
faker-0bd2f394475a5363f2f0eddc11322c9c6007a5d2.zip
docs(name): use single quotes in examples and English as result (#1167)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/name/index.ts14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts
index 07a4164d..46d31de3 100644
--- a/src/modules/name/index.ts
+++ b/src/modules/name/index.ts
@@ -75,8 +75,8 @@ export class Name {
*
* @example
* faker.name.firstName() // 'Antwan'
- * faker.name.firstName("female") // 'Victoria'
- * faker.name.firstName("male") // 'Tom'
+ * faker.name.firstName('female') // 'Victoria'
+ * faker.name.firstName('male') // 'Tom'
*/
firstName(gender?: GenderType): string {
const { first_name, female_first_name, male_first_name } =
@@ -97,8 +97,8 @@ export class Name {
*
* @example
* faker.name.lastName() // 'Hauck'
- * faker.name.lastName("female") // 'Grady'
- * faker.name.lastName("male") // 'Barton'
+ * faker.name.lastName('female') // 'Grady'
+ * faker.name.lastName('male') // 'Barton'
*/
lastName(gender?: GenderType): string {
const { last_name, female_last_name, male_last_name } =
@@ -118,9 +118,9 @@ export class Name {
* Can be either `'female'` or `'male'`.
*
* @example
- * faker.name.middleName() // 'Доброславівна'
- * faker.name.middleName("female") // 'Анастасівна'
- * faker.name.middleName("male") // 'Вікторович'
+ * faker.name.middleName() // 'James'
+ * faker.name.middleName('female') // 'Eloise'
+ * faker.name.middleName('male') // 'Asher'
*/
middleName(gender?: GenderType): string {
const { middle_name, female_middle_name, male_middle_name } =