Accentuate month being 0-index in getMonth example #26734
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`Date.getMonth` behavior differ slightly from the similar method as it return the index of the month and is 0-indexed, while the other method return ordinal values instead of index and don't have this distinction.
One could be tempted to run `${year}-${month}-${day}` and `${hour}:${minutes}:${seconds}` after the code in exemple to get iso formated date and time but the month would be off by one as iso month are 1-indexed, january being 1 and december being 12.
Adding a comment with the actual output put emphasis on this difference in behavior and might prevent people being surprised by that after the fact. The value chosen for the date is partly random. 2000 is the first year not starting with 19; January cause the month part to be 0 which should call attention to itself; 17 is high enough so it cannot be a month and I like it; 16 is in the 24h hour clock; 45 is high enough to not be confused with an hour; 30 is here for lack of imagination.
|
Preview URLs (comment last updated: 2023-05-13 10:42:40) |
Josh-Cena
reviewed
May 13, 2023
files/en-us/web/javascript/reference/global_objects/date/index.md
Outdated
Show resolved
Hide resolved
Josh-Cena
reviewed
May 13, 2023
files/en-us/web/javascript/reference/global_objects/date/index.md
Outdated
Show resolved
Hide resolved
Josh-Cena
reviewed
May 13, 2023
files/en-us/web/javascript/reference/global_objects/date/index.md
Outdated
Show resolved
Hide resolved
Josh-Cena
approved these changes
May 13, 2023
HannahPeuckmann
pushed a commit
to HannahPeuckmann/content
that referenced
this pull request
May 15, 2023
* Accentuate month being 0-index in get month example
`Date.getMonth` behavior differ slightly from the similar method as it return the index of the month and is 0-indexed, while the other method return ordinal values instead of index and don't have this distinction.
One could be tempted to run `${year}-${month}-${day}` and `${hour}:${minutes}:${seconds}` after the code in exemple to get iso formated date and time but the month would be off by one as iso month are 1-indexed, january being 1 and december being 12.
Adding a comment with the actual output put emphasis on this difference in behavior and might prevent people being surprised by that after the fact. The value chosen for the date is partly random. 2000 is the first year not starting with 19; January cause the month part to be 0 which should call attention to itself; 17 is high enough so it cannot be a month and I like it; 16 is in the 24h hour clock; 45 is high enough to not be confused with an hour; 30 is here for lack of imagination.
* Update files/en-us/web/javascript/reference/global_objects/date/index.md
* Update files/en-us/web/javascript/reference/global_objects/date/index.md
* Update files/en-us/web/javascript/reference/global_objects/date/index.md
---------
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
dipikabh
added a commit
that referenced
this pull request
Jun 13, 2023
* Updating content that storage is always partitioned and storage access grants are limited to cookies * Avoiding the phrase 'cookie storage' * implemented review from Tricolon * reverted changes to storage_access_policy * clean up * add service workers to partitioned APIs * linting * Fix: Use language keywords instead of framework type names in the examples of 'WebSocket' (#26725) * Add a bit about SPAs (#26711) * Bump @mdn/yari from 2.18.1 to 2.20.0 (#26730) * DNR corrections in URLTransform's queryTransform (#26732) * Fix the description of the display property according to the CSS specification (#26612) * change: `block element box` -> `block level box` * change: `inline element boxes` -> `inline level boxes` * change: `block element` -> `block level` * change: `inline element` -> `inline level` * fix: `inline/block level box` -> `inline/block box` * change: `inline/block level` -> `inline-level/block-level element` * fix: `block level` -> `block-level element` * Adding missing sections for `container*` (#25739) * Update sections for `container` * Update sections for `container-name` * Update sections for `container-type` * Update files/en-us/web/css/container-name/index.md --------- Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> Co-authored-by: Estelle Weyl <estelle@weyl.org> Co-authored-by: Brian Thomas Smith <brian@smith.berlin> * fix(prefers-reduced-motion): Edit text and improve example (#26630) * edits to page for clarity * improve example explanation * fix review comments * Update files/en-us/web/css/@media/prefers-reduced-motion/index.md --------- Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> * Added info for 'muted' driven emission (#26641) * Added info for 'muted' driven emission Fixing missing information that muting also fires this event. Standard spec: https://html.spec.whatwg.org/multipage/media.html#event-media-volumechange * Update files/en-us/web/api/htmlmediaelement/volumechange_event/index.md * lint --------- Co-authored-by: wbamberg <will@bootbonnet.ca> * Add page for prefers-reduced-transparency (#25289) * Add page for prefers-reduced-transparency * Update page for prefers-reduced-transparency Changed text as requested in PR comments. --------- Co-authored-by: Brian Thomas Smith <brian@smith.berlin> Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> * Fix arrow syntax explanation (#26704) * remove bracket around the parameter The example should omit the brackets around the parameter, as described in the explanation above this code. * Update files/en-us/learn/javascript/building_blocks/functions/index.md * Update files/en-us/learn/javascript/building_blocks/functions/index.md * Update index.md --------- Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * Add RTCAudioSourceStats (#26667) * Add RTCAudioSourceStats * Update files/en-us/web/api/rtcaudiosourcestats/index.md Co-authored-by: wbamberg <will@bootbonnet.ca> * Apply suggestions from code review Co-authored-by: wbamberg <will@bootbonnet.ca> * Apply suggestions from code review Co-authored-by: wbamberg <will@bootbonnet.ca> * Update files/en-us/web/api/rtcaudiosourcestats/index.md * Add keys for BCD data * Make it clear that the audiolevel can also be calculated --------- Co-authored-by: wbamberg <will@bootbonnet.ca> * correct language tag of code fence (#26738) * Fix code comment in dialog example (#26669) * Update index.md (#26744) * Remove Prettier ignore for /web/web_components (#24225) * Bump @mdn/yari from 2.20.0 to 2.20.3 (#26747) * Update length values description (#26728) * Update length values description length values are not always absolute. For example we can use 2em for width property as a length value but it is not absolute. I corrected this in the Values section. * Update files/en-us/web/css/width/index.md Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> --------- Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> * Add TransformStream note about returning a promise (#26757) * Remove emphasis on WritableStream controller (#26758) * Remove emphasis on WritableStream controller * copy edit * lint --------- Co-authored-by: wbamberg <will@bootbonnet.ca> * fix: Updated description of example which in `JavaScript.Object` to be more accurate (#26742) Update index.md * Fix some more return statements (#26759) * Fix return value for toString * Fix some more return statements * Fix 26745: don't auto-play (#26748) * Fix 26743: Fix return value; improve example (#26753) * Fix return value for Range: getBoundingClientRect() (#26754) * Mention that Set iterators have a defined order (#26727) * Mention that Set iterators have a defined order * Do it for Map --------- Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * Accentuate month being 0-index in getMonth example (#26734) * Accentuate month being 0-index in get month example `Date.getMonth` behavior differ slightly from the similar method as it return the index of the month and is 0-indexed, while the other method return ordinal values instead of index and don't have this distinction. One could be tempted to run `${year}-${month}-${day}` and `${hour}:${minutes}:${seconds}` after the code in exemple to get iso formated date and time but the month would be off by one as iso month are 1-indexed, january being 1 and december being 12. Adding a comment with the actual output put emphasis on this difference in behavior and might prevent people being surprised by that after the fact. The value chosen for the date is partly random. 2000 is the first year not starting with 19; January cause the month part to be 0 which should call attention to itself; 17 is high enough so it cannot be a month and I like it; 16 is in the 24h hour clock; 45 is high enough to not be confused with an hour; 30 is here for lack of imagination. * Update files/en-us/web/javascript/reference/global_objects/date/index.md * Update files/en-us/web/javascript/reference/global_objects/date/index.md * Update files/en-us/web/javascript/reference/global_objects/date/index.md --------- Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * Do not use JSON.stringify in console.log (#26662) * Update index.md * fix: not use JSON.stringify when print via console.log * fix: Update the description of callbackFn's accumulator in `Array.reduceRight()` (#26594) * Update index.md * Update files/en-us/web/javascript/reference/global_objects/array/reduceright/index.md * Update files/en-us/web/javascript/reference/global_objects/array/reduceright/index.md --------- Co-authored-by: Joshua Chen <sidachen2003@gmail.com> * Remove random arrow from Endianness example (#26767) * Add missed redirect (#26769) * remove self-reference links (#26764) * remove a self reference link * Update index.md * Update index.md (#26771) * Update index.md Added the missing bracket * Update files/en-us/web/api/stylepropertymap/append/index.md --------- Co-authored-by: Hamish Willee <hamishwillee@gmail.com> * correct http status code message (#26765) * Fix 26741: reduce ambiguity, remove unneeded word (#26750) * Fix 26741: reduce ambiguity, remove unneeded word * Update files/en-us/web/http/overview/index.md --------- Co-authored-by: Hamish Willee <hamishwillee@gmail.com> * Window.beforeunload event requires sticky activation (#26772) * Update `:paused` content (#26768) * Update `:paused` content * Update files/en-us/web/css/_colon_paused/index.md * Update files/en-us/web/css/_colon_paused/index.md Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> * Update files/en-us/web/css/_colon_paused/index.md Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> * Update files/en-us/web/css/_colon_paused/index.md Co-authored-by: A1lo <yin199909@aliyun.com> --------- Co-authored-by: Joshua Chen <sidachen2003@gmail.com> Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> Co-authored-by: A1lo <yin199909@aliyun.com> * FF114 ECMAScript module support (#26774) * removed while loop from the example (#26588) Co-authored-by: Mohit Maheshwari <mohitmaheshwari@1MGH-LPTP-1483.local> * Updating content that storage is always partitioned and storage access grants are limited to cookies * Avoiding the phrase 'cookie storage' * implemented review from Tricolon * less firefox centric * clean up merge * capitalization --------- Co-authored-by: Hannah Peuckmann <peuckmann@uni-potsdam.de> Co-authored-by: Bodhi van Baardewijk <bodhivanbaardewijk@hotmail.com> Co-authored-by: wbamberg <will@bootbonnet.ca> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: rebloor <git@sherpa.co.nz> Co-authored-by: oti <oti@users.noreply.github.com> Co-authored-by: yarusome <97945148+yarusome@users.noreply.github.com> Co-authored-by: Estelle Weyl <estelle@openwebdocs.org> Co-authored-by: Estelle Weyl <estelle@weyl.org> Co-authored-by: Brian Thomas Smith <brian@smith.berlin> Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org> Co-authored-by: Ctibor Laky <luckylooke@gmail.com> Co-authored-by: CanadaHonk <19228318+CanadaHonk@users.noreply.github.com> Co-authored-by: nintendoit <91181094+nintendoit@users.noreply.github.com> Co-authored-by: Joshua Chen <sidachen2003@gmail.com> Co-authored-by: Hamish Willee <hamishwillee@gmail.com> Co-authored-by: A1lo <yin199909@aliyun.com> Co-authored-by: Fredrik Vaeng Røtnes <frwdrik@gmail.com> Co-authored-by: Sebastian Sobociński <hiddenboox@users.noreply.github.com> Co-authored-by: Queen Vinyl Da.i'gyu-Kazotetsu <vinyldarkscratch@gmail.com> Co-authored-by: Amirhosain Shahsavari <shvb2007@gmail.com> Co-authored-by: Dan Cecile <dancecile@gmail.com> Co-authored-by: Jason Lam <jasonlamv-t@hotmail.com> Co-authored-by: Mathias Stearn <redbeard0531@gmail.com> Co-authored-by: L. Coues <couesl@gmail.com> Co-authored-by: Steven Nyman <35897452+stevennyman@users.noreply.github.com> Co-authored-by: Onkar Ruikar <87750369+OnkarRuikar@users.noreply.github.com> Co-authored-by: Arka Poddar <poddararka27@gmail.com> Co-authored-by: Jason Ren <40999116+jasonren0403@users.noreply.github.com> Co-authored-by: Wonder Dai <37327614+daiwanxing@users.noreply.github.com> Co-authored-by: MohitMaheshwari1711 <39165319+MohitMaheshwari1711@users.noreply.github.com> Co-authored-by: Mohit Maheshwari <mohitmaheshwari@1MGH-LPTP-1483.local>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
In the documentation of the Javascript Date object, in the section showing how to get the main components of the date, add a specific date and a pair of comment with the actual output of the methods.
Motivation
Date.getMonthbehavior differ slightly from the similar method as it return the index of the month and is 0-indexed, while the other method return ordinal values instead of index and don't have this distinction.Adding a comment with the actual output put emphasis on this difference in behavior and might prevent people being surprised by that after the fact. I personally assumed
getMonthreturn an iso-compatible month number and didn't notice 4 wasn't the correct number for may until I wrote similar code using PHP date format instead of string formatting and noticing I did get different output for the same date.Additional details
The value chosen for the date is partly random, as in chosen arbitrary.
2000 is the first year not starting with 19; January cause the month part to be 0 which should call attention to itself; 17 is high enough so it cannot be a month and I like it; 16 is in the 24h hour clock; 45 is high enough to not be confused with an hour; 30 is here for lack of imagination.
Related issues and pull requests
Nothing that I know of