Skip to content

Commit 850abc4

Browse files
committed
docs(date): clarify the purpose of the context parameter - simplify
1 parent d691a22 commit 850abc4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/modules/date/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ export class DateModule {
220220
*
221221
* @param options The optional options to use.
222222
* @param options.abbr Whether to return an abbreviation. Defaults to `false`.
223-
* @param options.context Whether to return the name of a month in a context. In the default `en` locale this has no effect, however, in other locales like `fr` or `ru`, it will return the name of the month in the context of a date. This may affect grammar or capitalization, for example "январь" with `{ context: false }` and "января" with `{ context: true }` in `ru`. Defaults to `false`.
223+
* @param options.context Whether to return the name of a month in the context of a date. In the default `en` locale this has no effect, however, in other locales like `fr` or `ru`, this may affect grammar or capitalization, for example `'январь'` with `{ context: false }` and `'января'` with `{ context: true } ` in `ru`. Defaults to `false`.
224224
*
225225
* @example
226226
* faker.date.month() // 'October'
@@ -256,7 +256,7 @@ export class DateModule {
256256
*
257257
* @param options The optional options to use.
258258
* @param options.abbr Whether to return an abbreviation. Defaults to `false`.
259-
* @param options.context Whether to return the day of the week in a context. In the default `en` locale this has no effect, however, in other locales like `fr` or `ru`, it will return the day of the week in the context of a date. This may affect grammar or capitalization, for example "Lundi" with `{ context: false }` and "lundi" with `{ context: true }` in `fr`. Defaults to `false`.
259+
* @param options.context Whether to return the day of the week in the context of a date. In the default `en` locale this has no effect, however, in other locales like `fr` or `ru`, this may affect grammar or capitalization, for example `'Lundi'` with `{ context: false }` and `'lundi'` with `{ context: true }` in `fr`. Defaults to `false`.
260260
*
261261
* @example
262262
* faker.date.weekday() // 'Monday'

0 commit comments

Comments
 (0)