docs: add ## Notes section to time/quarter-of-year README#12734
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: add ## Notes section to time/quarter-of-year README#12734Planeshifter wants to merge 1 commit into
## Notes section to time/quarter-of-year README#12734Planeshifter wants to merge 1 commit into
Conversation
Adds the `## Notes` section present in 17 of 19 sibling `@stdlib/time/*` packages (~89% conformance) to the `quarter-of-year` README. Boilerplate text matches the disclaimer used in recent PRs (#12313, #12369) that added the same note to `iso-weeks-in-year`, `day-of-quarter`, and `day-of-year`. `quarterOfYear()` uses `Date.prototype.getMonth()` (local time) when called with a `Date` argument, so the daylight-savings / timezone disclaimer is semantically applicable, matching sibling `day-of-quarter`. Generator-owned `docs/repl.txt` and `docs/types/index.d.ts` are intentionally left untouched.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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 adds the
## Notessection present in 17 of 19 sibling@stdlib/time/*packages (~89% conformance) to thequarter-of-yearREADME. The boilerplate text matches the disclaimer added toiso-weeks-in-year(#12313),day-of-quarter, andday-of-year(#12369).quarterOfYear()accepts aDateargument and usesDate.prototype.getMonth()(local time), so the daylight-savings / timezone disclaimer is semantically applicable, matching siblingday-of-quarter.Namespace summary
@stdlib/time/*direct children withpackage.json)file_tree(set),pkg_json.top_keys,readme_sections(set and sequence),test_files,examples_fileserrorConstruction(uniformlyformat),@examplepresence, JSDoc tag families (matched to per-function semantics)benchmark/benchmark.jspresence (2/19),pkg_json.scripts_keys,pkg_json.stdlib_keysquarter-of-yearSole outlier with confirmed, mechanically fixable drift. The README jumped from
## Usagedirectly to## Examples, skipping the## Notessection present in 17 of 19 siblings (89.5% conformance). The Notes content is identical verbatim across all conformant siblings; the disclaimer applies semantically becausequarterOfYearreads the month viaDate.prototype.getMonth()in local time.Validation
package.jsonshapes, README section sets and sequences, test/benchmark/example filenames across all 19 members.require(), public-function shapes — scanned directly across all 19lib/main.jsfiles.confirmed-drift. Semantic-review skipped (purely structural feature).base(meta sub-namespace),tic/toclacking CLI infrastructure (no shell use case; CLI not present in ≥90% of stdlib outside this namespace), andbenchmark/benchmark.jsadds across 17 packages (below 75% majority threshold).docs/repl.txt,docs/types/index.d.ts) intentionally not touched, despite some prior maintainer PRs (docs: documentDateinput and add Notes section intime/iso-weeks-in-year#12313) editing them; this PR plays conservative on generator-owned scope.Related Issues
No.
Questions
No.
Other
Recent precedent for this exact correction on adjacent siblings: #12313 (
iso-weeks-in-year) and #12369 (day-of-quarter,day-of-year). Both added the verbatim Notes block in the same README position.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of a cross-package API drift detection routine: structural and semantic features extracted across all 19 direct children of
@stdlib/time/, majority pattern identified per feature (75% threshold), single high-signal outlier (quarter-of-yearmissing## Notes) confirmed via multi-agent validation, and the verbatim sibling boilerplate applied.@stdlib-js/reviewers
Generated by Claude Code