docs: add note concerning generalization#12369
Merged
Merged
Conversation
Adds a `## Notes` section to the package README. The `## Notes` section is present in 15/19 (78.9%) `time/*` packages, meeting the majority threshold. The DST/timezone disclaimer bullet matches the boilerplate used verbatim across 9 sibling packages (`days-in-month`, `days-in-year`, `hours-in-month`, `hours-in-year`, `minutes-in-month`, `minutes-in-year`, `seconds-in-month`, `seconds-in-year`, `iso-weeks-in-year`); `day-of-year` extracts month/day/year from a `Date` via local-time accessors and is subject to the same DST/timezone caveats.
Adds a `## Notes` section to the package README. The `## Notes` section is present in 15/19 (78.9%) `time/*` packages, meeting the majority threshold. The DST/timezone disclaimer bullet matches the boilerplate used verbatim across 9 sibling packages (`days-in-month`, `days-in-year`, `hours-in-month`, `hours-in-year`, `minutes-in-month`, `minutes-in-year`, `seconds-in-month`, `seconds-in-year`, `iso-weeks-in-year`); `day-of-quarter` delegates to `day-of-year`/`quarter-of-year` and reads month/day/year from a `Date` via local-time accessors, so it is subject to the same DST/timezone caveats.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
May 30, 2026
time/day-of-year and time/day-of-quarter
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 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
This pull request:
## Notessection to two@stdlib/timepackage READMEs (day-of-yearandday-of-quarter) so they carry the same DST/timezone caveat already documented in their sibling packages. No source, type, or test changes.Namespace summary
@stdlib/timepackage.jsonkeys/scripts/stdlibkeys/directories/keywords/bin/os/engines,manifest.jsonkeys, README section list and ordering,test//benchmark//examples/filenames, public signature, return kind, validation prologue, error construction, JSDoc@param/@returns/@throws/@example, and source-level dependencies.package.jsontop-level keys (19/19),osandenginesshape (19/19), universal keywords (19/19),directorieskeys (19/19),lib/index.jsanddocs/types/*(19/19),lib/main.jsanddocs/repl.txt(18/19),bin/CLI files (16/19),## Usageand## Examples(19/19),## CLIand its sub-sections (16/19),## Notes(15/19, 78.9%), JSDoc@exampleand@returns(18/19), error construction viaformat(15/15 among packages that perform validation), return kindvalue(19/19).## See Also(14/19, also gated as auto-populated content),### NotesCLI sub-section (2/19),benchmark/benchmark.js(2/19),browserfield (1/19), package-specific implementation files (lib/days.json,lib/detect.js,lib/polyfill.js,lib/browser.js).time/day-of-yearAdds a
## Notessection to the@stdlib/time/day-of-yearREADME documenting that the return value is a generalization and does not account for DST, timezone crossings, or related time complications. The note matches verbatim the disclaimer already present in nine sibling packages (days-in-month,days-in-year,hours-in-month,hours-in-year,minutes-in-month,minutes-in-year,seconds-in-month,seconds-in-year,iso-weeks-in-year) and bringsday-of-yearinto conformance with the 78.9% majority oftime/*packages that carry this section. The addition is warranted becauseday-of-yearreads month, day, and year via local-time accessors and is subject to the same DST and timezone exposure as those siblings.time/day-of-quarterAdds a
## Notessection to the@stdlib/time/day-of-quarterREADME to align with the 15 of 19 siblingtime/*packages that already carry this section. The DST/timezone caveat is verbatim from nine siblings (days-in-month,days-in-year,hours-in-month,hours-in-year,minutes-in-month,minutes-in-year,seconds-in-month,seconds-in-year,iso-weeks-in-year) and applies here becauseday-of-quarterdelegates today-of-yearandquarter-of-year, reading month, day, and year through local-time accessors. No logic changes; documentation only.Related Issues
None.
Questions
No.
Other
Validation
package.jsonshape, README section list/order,manifest.jsonshape, andtest//benchmark//examples/filenames captured for every member of the namespace.lib/main.js,lib/index.js, andlib/validate.js(where present) and reported public signature, return kind, validation prologue, error construction, JSDoc shape, and source-level dependencies.quarter-of-year—## Notesis also absent, but the templated DST/timezone bullet does not apply (function maps month index → quarter index without consulting any DST- or timezone-sensitive date value).base— sub-namespace re-export package; absence of## Notes,## CLI,bin, and the CLI fixtures is intentional.tic,toc— high-resolution timing primitives; CLI is conceptually inapplicable, so the missing CLI section/files are intentional.## See Also— auto-populated section; excluded from drift correction by routine policy.@paramtype-union ordering): excluded as below the 75% threshold and non-mechanical.The inserted Notes block in both files is byte-identical to the
time/days-in-yeartemplate (diffof the bracketed<section class="notes">…<!-- /.notes -->ranges returned empty).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared by Claude Code running a cross-package API drift detection routine over the
@stdlib/timenamespace: feature extraction, majority-vote computation, three-agent validation (two opus, one sonnet) of the candidate corrections, and patch authoring. Both corrections are mechanical README insertions whose templated text and insertion position are byte-identical to the nine-sibling convention; no source or test files were modified.@stdlib-js/reviewers
Generated by Claude Code