diff options
| author | ST-DDT <[email protected]> | 2024-02-01 17:27:28 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-02-01 17:27:28 +0100 |
| commit | 431681ea048ee9d56681d76e5a1c882762e8860e (patch) | |
| tree | 698ad816ff16f5621d2a089209b3ada8a5bd75d4 /src/modules | |
| parent | 8ccc49d2071b1c92ba751f427905587adddb050c (diff) | |
| download | faker-431681ea048ee9d56681d76e5a1c882762e8860e.tar.xz faker-431681ea048ee9d56681d76e5a1c882762e8860e.zip | |
docs: fix missing or invalid jsdocs (#2630)
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/location/index.ts | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts index 0bd679cc..0c94317b 100644 --- a/src/modules/location/index.ts +++ b/src/modules/location/index.ts @@ -623,10 +623,9 @@ export class LocationModule extends ModuleBase { /** * Generates a random longitude. * - * @param options An options object. - * @param options.max The upper bound for the longitude to generate. Defaults to `180`. - * @param options.min The lower bound for the longitude to generate. Defaults to `-180`. - * @param options.precision The number of decimal points of precision for the longitude. Defaults to `4`. + * @param max The upper bound for the longitude to generate. Defaults to `180`. + * @param min The lower bound for the longitude to generate. Defaults to `-180`. + * @param precision The number of decimal points of precision for the longitude. Defaults to `4`. * * @example * faker.location.longitude() // -30.9501 @@ -992,8 +991,7 @@ export class LocationModule extends ModuleBase { /** * Returns a random ordinal direction (northwest, southeast, etc). * - * @param options Whether to use abbreviated or an options object. - * @param options.abbreviated If true this will return abbreviated directions (NW, SE, etc). + * @param abbreviated If true this will return abbreviated directions (NW, SE, etc). * Otherwise this will return the long name. Defaults to `false`. * * @example |
