diff options
| author | ST-DDT <[email protected]> | 2023-11-21 00:23:16 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-11-20 23:23:16 +0000 |
| commit | 808aa82f3f86a0b25f272c0c1760115a0920b614 (patch) | |
| tree | 94a4485ebd3933b710b9280fe8f68c2d041d4adb /src/modules/string | |
| parent | 96195673448e9b56ea330a1d02ff63374a11ca8b (diff) | |
| download | faker-808aa82f3f86a0b25f272c0c1760115a0920b614.tar.xz faker-808aa82f3f86a0b25f272c0c1760115a0920b614.zip | |
docs: consistent @see jsdoc tags (#2473)
Diffstat (limited to 'src/modules/string')
| -rw-r--r-- | src/modules/string/index.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/string/index.ts b/src/modules/string/index.ts index e841e29d..4240a6f1 100644 --- a/src/modules/string/index.ts +++ b/src/modules/string/index.ts @@ -338,7 +338,7 @@ export class StringModule extends SimpleModuleBase { * @param options.length The number or range of characters to generate after the prefix. Defaults to `1`. * @param options.prefix Prefix for the generated number. Defaults to `'0b'`. * - * @see faker.number.binary() If you would like to generate a `binary number` (within a range). + * @see faker.number.binary(): For generating a binary number (within a range). * * @example * faker.string.binary() // '0b1' @@ -390,7 +390,7 @@ export class StringModule extends SimpleModuleBase { * @param options.length The number or range of characters to generate after the prefix. Defaults to `1`. * @param options.prefix Prefix for the generated number. Defaults to `'0o'`. * - * @see faker.number.octal() If you would like to generate an `octal number` (within a range). + * @see faker.number.octal(): For generating an octal number (within a range). * * @example * faker.string.octal() // '0o3' @@ -543,7 +543,7 @@ export class StringModule extends SimpleModuleBase { * @param options.allowLeadingZeros Whether leading zeros are allowed or not. Defaults to `true`. * @param options.exclude An array of digits which should be excluded in the generated string. Defaults to `[]`. * - * @see faker.number.int() If you would like to generate a `number` (within a range). + * @see faker.number.int(): For generating a number (within a range). * * @example * faker.string.numeric() // '2' |
