This repository was archived by the owner on Apr 12, 2024. It is now read-only.
docs: Clarify documentation of input[week]#16104
Merged
Narretz merged 2 commits intoJul 13, 2017
Merged
Conversation
Add a note to documentation of input[week] to explicitly state that the resulting Date object's value is set to Thursday at midnight of the specified week Resolves #15883
gkalpak
suggested changes
Jul 12, 2017
Member
gkalpak
left a comment
There was a problem hiding this comment.
One minor suggestion. LGTM otherwise.
Thx for taking this on 👍
| * Invalid `Date` objects (dates whose `getTime()` is `NaN`) will be rendered as an empty string. | ||
| * | ||
| * The value of the resulting Date object will be set to Thursday at 00:00:00 of the requested week, | ||
| * due to ISO-8601 week numbering standards. |
Member
There was a problem hiding this comment.
Looks good. Can you please also add a link to https://en.wikipedia.org/wiki/ISO_8601#Week_dates?
Contributor
Author
There was a problem hiding this comment.
Good idea, should have thought of that. Will do!
Add a note to documentation of input[week] to explicitly state that the resulting Data object's value is set to Thursday at midnight of the specified week, and add a link to explain ISO's week numbering system Resolves #15883
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
Add a note to documentation of input[week] to explicitly state that the
resulting Date object's value is set to Thursday at midnight of the
specified week
Resolves #15883
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
docs update
What is the current behavior? (You can also link to an open issue here)
#15883
The docs do not specify the day and time of a Date created by input[week]
What is the new behavior (if this is a feature change)?
The docs now explicitly state that the resulting Date object's value is set to Thursday at midnight of the
specified week
Does this PR introduce a breaking change?
No
Please check if the PR fulfills these requirements
Other information:
Thought this looked like a nice opportunity for baby's first pull request! Hope I did everything right...