diff options
| author | ST-DDT <[email protected]> | 2024-03-05 22:33:35 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-03-05 22:33:35 +0100 |
| commit | ade91fd30d6b5fbcc2ab2534502467b1e0f3b086 (patch) | |
| tree | ee823735e3141a452297aae4db6a208ce89241ea /src/modules/git | |
| parent | 489bbc243f3094464888bdf7fb90835fcfa57691 (diff) | |
| download | faker-ade91fd30d6b5fbcc2ab2534502467b1e0f3b086.tar.xz faker-ade91fd30d6b5fbcc2ab2534502467b1e0f3b086.zip | |
docs: improve jsdocs default texts (#2717)
Diffstat (limited to 'src/modules/git')
| -rw-r--r-- | src/modules/git/index.ts | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts index 15cd21a3..0c50b614 100644 --- a/src/modules/git/index.ts +++ b/src/modules/git/index.ts @@ -29,8 +29,8 @@ export class GitModule extends ModuleBase { * Generates a random commit entry as printed by `git log`. * * @param options Options for the commit entry. - * @param options.merge Set to `true` to generate a merge message line. - * @param options.eol Choose the end of line character to use. Defaults to 'CRLF'. + * @param options.merge Whether to generate a merge message line. Defaults to 20% `true` and 80% `false`. + * @param options.eol Choose the end of line character to use. Defaults to `'CRLF'`. * 'LF' = '\n', * 'CRLF' = '\r\n' * @param options.refDate The date to use as reference point for the commit. Defaults to `new Date()`. @@ -192,7 +192,7 @@ export class GitModule extends ModuleBase { * - 8 for GitLab * * @param options Options for the commit sha. - * @param options.length The length of the commit sha. Defaults to 40. + * @param options.length The length of the commit sha. Defaults to `40`. * * @example * faker.git.commitSha() // '2c6e3880fd94ddb7ef72d34e683cdc0c47bec6e6' |