Skip to content

new Date(year, month) constructor documentation is misleading #49350

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

Jump to bottom
Closed
Yonom opened this issue Jun 2, 2022 · 0 comments · Fixed by #49649
Closed

new Date(year, month) constructor documentation is misleading #49350

Yonom opened this issue Jun 2, 2022 · 0 comments · Fixed by #49649
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Experience Enhancement Noncontroversial enhancements Help Wanted You can do this Suggestion An idea for TypeScript
Milestone
Backlog

Comments

@Yonom
Copy link

Yonom commented Jun 2, 2022

Bug Report

🔎 Search Terms

date constructor month

🕗 Version & Regression Information

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about naming conventions

⏯ Playground Link

Playground link with relevant code

💻 Code

// this is May 2022
new Date(2022, 4)

🙁 Actual behavior

image

The date constructor documentation gives no indication that the month parameter is zero index based (January is month 0, February is month 1). This can cause off-by-one error bugs that are hard to detect.

🙂 Expected behavior

I expected the documentation to be clear about the type of value expected in the constructor. For example:
@RyanCavanaugh RyanCavanaugh added Suggestion An idea for TypeScript Help Wanted You can do this Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Experience Enhancement Noncontroversial enhancements labels Jun 2, 2022
@RyanCavanaugh RyanCavanaugh added this to the Backlog milestone Jun 2, 2022
@jackmorrison12 jackmorrison12 mentioned this issue Jun 16, 2022
Merged
mkubilayk pushed a commit to bloomberg/TypeScript that referenced this issue Jun 22, 2022
@jackmorrison12
Fix misleading Date constructor documentation (addresses microsoft#49350
ac1aa19 
) (#73)

* Update month parameter to monthIndex and add docs for Date constructor

Signed-off-by: jmorrison152 <[email protected]>

* Add baseline changes

Signed-off-by: jmorrison152 <[email protected]>
@jackmorrison12 jackmorrison12 mentioned this issue Jun 23, 2022
Merged
clarfonthey pushed a commit to clarfonthey/TypeScript that referenced this issue Aug 9, 2022
@jackmorrison12
Fix misleading Date constructor documentation (addresses microsoft#49350
e5b400c 
) (microsoft#49649)

* Update month parameter to monthIndex and add docs for Date constructor

Signed-off-by: jmorrison152 <[email protected]>

* Add baseline changes

Signed-off-by: jmorrison152 <[email protected]>

* Fix misleading Date constructor documentation (addresses microsoft#49350) (microsoft#73)

* Update month parameter to monthIndex and add docs for Date constructor

Signed-off-by: jmorrison152 <[email protected]>

* Add baseline changes

Signed-off-by: jmorrison152 <[email protected]>

* Update baselines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Domain: lib.d.ts The issue relates to the different libraries shipped with TypeScript Experience Enhancement Noncontroversial enhancements Help Wanted You can do this Suggestion An idea for TypeScript
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

Fix misleading Date constructor documentation (addresses #49350) bloomberg/TypeScript
2 participants
@Yonom @RyanCavanaugh