Skip to content

docs(date): clarify the purpose of the context parameter #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Nov 25, 2022
Merged

docs(date): clarify the purpose of the context parameter #1576

Changes from 6 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
bbe917c
docs(date): clarify the purpose of the context parameter
matthewmayer Nov 20, 2022
b58656a
docs(date): clarify the purpose of the context parameter
matthewmayer Nov 20, 2022
3ec6565
Update src/modules/date/index.ts
Nov 21, 2022
231ba62
Update src/modules/date/index.ts
Nov 21, 2022
f9f13de
docs(date): clarify the purpose of the context parameter
matthewmayer Nov 21, 2022
e95ec5d
docs(date): clarify the purpose of the context parameter - use differ…
matthewmayer Nov 21, 2022
140531d
Update src/modules/date/index.ts
Nov 22, 2022
d691a22
Merge branch 'next' into chore/clarify-context-parameter-for-month-an…
ST-DDT Nov 22, 2022
850abc4
docs(date): clarify the purpose of the context parameter - simplify
matthewmayer Nov 23, 2022
8d24f85
Update src/modules/date/index.ts
Nov 24, 2022
cd9c158
Merge branch 'next' into chore/clarify-context-parameter-for-month-an…
ST-DDT Nov 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/modules/date/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ export class DateModule {
*
* @param options The optional options to use.
* @param options.abbr Whether to return an abbreviation. Defaults to `false`.
* @param options.context Whether to return the name of a month in a context. Defaults to `false`.
* @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`.
*
* @example
* faker.date.month() // 'October'
Expand Down Expand Up @@ -256,7 +256,7 @@ export class DateModule {
*
* @param options The optional options to use.
* @param options.abbr Whether to return an abbreviation. Defaults to `false`.
* @param options.context Whether to return the day of the week in a context. Defaults to `false`.
* @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`.
*
* @example
* faker.date.weekday() // 'Monday'
Expand Down