aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHanna <[email protected]>2022-08-04 20:23:01 +0200
committerGitHub <[email protected]>2022-08-04 20:23:01 +0200
commit6321665a25fbea3098914b850f57666b8b234d9f (patch)
treecba5c550c8f124b6fa8d743e14cc514c70fe8955
parent5979f82e17d4f9adf80fa795afb668d57b33411f (diff)
downloadfaker-6321665a25fbea3098914b850f57666b8b234d9f.tar.xz
faker-6321665a25fbea3098914b850f57666b8b234d9f.zip
docs: fixed inconsitency in @see usage in jsdoc (#1224)
-rw-r--r--CONTRIBUTING.md2
-rw-r--r--src/definitions/finance.ts2
-rw-r--r--src/definitions/hacker.ts2
-rw-r--r--src/definitions/phone_number.ts2
-rw-r--r--src/modules/address/index.ts8
-rw-r--r--src/modules/company/index.ts2
-rw-r--r--src/modules/image/providers/unsplash.ts2
-rw-r--r--src/modules/phone/index.ts10
8 files changed, 15 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d056771b..82339869 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -59,7 +59,7 @@ Example:
```ts
/**
- * @see faker.cat.random
+ * @see faker.cat.random()
*
* @deprecated Use faker.cat.random() instead.
*/
diff --git a/src/definitions/finance.ts b/src/definitions/finance.ts
index 47ea6a96..89fc51ea 100644
--- a/src/definitions/finance.ts
+++ b/src/definitions/finance.ts
@@ -13,7 +13,7 @@ export type FinanceDefinitions = LocaleEntry<{
* The pattern by (lowercase) issuer name used to generate credit card codes.
* `L` will be replaced by the check bit.
*
- * @see Helpers.replaceCreditCardSymbols()
+ * @see faker.helpers.replaceCreditCardSymbols()
*/
credit_card: { [issuer: string]: string[] };
diff --git a/src/definitions/hacker.ts b/src/definitions/hacker.ts
index 5540a14f..ed9bdd15 100644
--- a/src/definitions/hacker.ts
+++ b/src/definitions/hacker.ts
@@ -29,7 +29,7 @@ export type HackerDefinitions = LocaleEntry<{
* May use any of the HackerDefinition keys wrapped in double braces
* (e.g. `I'm {{ingverb}} {{adjective}} {{noun}}`).
*
- * @see Helpers.mustache()
+ * @see faker.helpers.mustache()
*/
phrase: string[];
diff --git a/src/definitions/phone_number.ts b/src/definitions/phone_number.ts
index 3f805ea7..656efd4a 100644
--- a/src/definitions/phone_number.ts
+++ b/src/definitions/phone_number.ts
@@ -10,7 +10,7 @@ export type PhoneNumberDefinitions = LocaleEntry<{
* `!` will be replaced by a random digit (2-9).
* (e.g. `!##-!##-####` -> 272-285-0453)
*
- * @see Helpers.replaceSymbolWithNumber(format)
+ * @see faker.helpers.replaceSymbolWithNumber(format)
*/
formats: string[];
}>;
diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
index 28ba2c61..72ba6ed2 100644
--- a/src/modules/address/index.ts
+++ b/src/modules/address/index.ts
@@ -92,7 +92,7 @@ export class Address {
/**
* Returns a random localized city prefix.
*
- * @see faker.address.city
+ * @see faker.address.city()
*
* @example
* faker.address.cityPrefix() // 'East'
@@ -115,7 +115,7 @@ export class Address {
/**
* Returns a random localized city suffix.
*
- * @see faker.address.city
+ * @see faker.address.city()
*
* @example
* faker.address.citySuffix() // 'mouth'
@@ -218,7 +218,7 @@ export class Address {
/**
* Returns a random localized street suffix.
*
- * @see faker.address.street
+ * @see faker.address.street()
*
* @example
* faker.address.streetSuffix() // 'Streets'
@@ -240,7 +240,7 @@ export class Address {
/**
* Returns a random localized street prefix.
*
- * @see faker.address.street
+ * @see faker.address.street()
*
* @example
* fakerGH.address.streetPrefix() // 'Boame'
diff --git a/src/modules/company/index.ts b/src/modules/company/index.ts
index d98eb89e..0a164fec 100644
--- a/src/modules/company/index.ts
+++ b/src/modules/company/index.ts
@@ -62,7 +62,7 @@ export class Company {
*
* @param format The optional format index used to select a format.
*
- * @see faker.company.name
+ * @see faker.company.name()
*
* @example
* faker.company.companyName() // 'Zieme, Hauck and McClure'
diff --git a/src/modules/image/providers/unsplash.ts b/src/modules/image/providers/unsplash.ts
index 0c1eb7ec..f682718c 100644
--- a/src/modules/image/providers/unsplash.ts
+++ b/src/modules/image/providers/unsplash.ts
@@ -35,7 +35,7 @@ export class Unsplash {
/**
* Returns a random avatar url.
*
- * @see faker.internet.avatar
+ * @see faker.internet.avatar()
*
* @example
* faker.internet.avatar()
diff --git a/src/modules/phone/index.ts b/src/modules/phone/index.ts
index 7e071b61..683883d1 100644
--- a/src/modules/phone/index.ts
+++ b/src/modules/phone/index.ts
@@ -20,7 +20,7 @@ export class Phone {
*
* @param format Format of the phone number. Defaults to a random phone number format.
*
- * @see faker.phone.number
+ * @see faker.phone.number()
*
* @example
* faker.phone.phoneNumber() // '961-770-7727'
@@ -63,8 +63,8 @@ export class Phone {
*
* @param phoneFormatsArrayIndex Index in the `faker.definitions.phone_number.formats` array. Defaults to `0`.
*
- * @see faker.phone.phoneNumber
- * @see faker.helpers.replaceSymbolWithNumber
+ * @see faker.phone.phoneNumber()
+ * @see faker.helpers.replaceSymbolWithNumber()
*
* @example
* faker.phone.phoneNumberFormat() // '943-627-0355'
@@ -89,8 +89,8 @@ export class Phone {
/**
* Returns a random phone number format.
*
- * @see faker.phone.phoneNumber
- * @see faker.definitions.phone_number.formats
+ * @see faker.phone.phoneNumber()
+ * @see faker.definitions.phone_number.formats()
*
* @example
* faker.phone.phoneFormats() // '!##.!##.####'