diff options
| author | ST-DDT <[email protected]> | 2023-03-27 13:35:45 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-27 11:35:45 +0000 |
| commit | 87a5ba9896749d8bb6f0c7c84185f3f0a23f2f1f (patch) | |
| tree | 3a53f6bc2530384e4ce4dd7d1bb9c04a431f6bd0 | |
| parent | 4a3a6b967f1204fe7518a01ea7f8707a960bffd7 (diff) | |
| download | faker-87a5ba9896749d8bb6f0c7c84185f3f0a23f2f1f.tar.xz faker-87a5ba9896749d8bb6f0c7c84185f3f0a23f2f1f.zip | |
docs: mark method references in @deprecation messages (#1963)
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | src/modules/datatype/index.ts | 2 | ||||
| -rw-r--r-- | src/modules/random/index.ts | 6 |
3 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35ed17d1..12e7b59c 100644 --- 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 diff --git a/src/modules/datatype/index.ts b/src/modules/datatype/index.ts index 6a03362f..540c4ab5 100644 --- a/src/modules/datatype/index.ts +++ b/src/modules/datatype/index.ts @@ -220,7 +220,7 @@ export class DatatypeModule { * * @since 5.5.0 * - * @deprecated Use faker.string.sample() instead. + * @deprecated Use `faker.string.sample()` instead. */ string( options: diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts index 809c9322..2a44b0e2 100644 --- a/src/modules/random/index.ts +++ b/src/modules/random/index.ts @@ -245,7 +245,7 @@ export class RandomModule { * * @since 5.0.0 * - * @deprecated Use faker.string.alpha() instead. + * @deprecated Use `faker.string.alpha()` instead. */ alpha( options: @@ -305,7 +305,7 @@ export class RandomModule { * * @since 3.1.0 * - * @deprecated Use faker.string.alphanumeric() instead. + * @deprecated Use `faker.string.alphanumeric()` instead. */ alphaNumeric( count: number = 1, @@ -356,7 +356,7 @@ export class RandomModule { * * @since 6.3.0 * - * @deprecated Use faker.string.numeric() instead. + * @deprecated Use `faker.string.numeric()` instead. */ numeric( length: number = 1, |