docs: fix heading levels#13010
Merged
Merged
Conversation
…` README Replaces `#####` (5-hash) heading on line 33 with `####` (4-hash) so the constant-identifier sub-heading inside `## Usage` matches the convention used by 65 of 67 sibling packages (97% conformance). The C-API section within the same file (line 91) already uses `####`, and the float32 sibling (`constants/float32/smallest-normal`) uses `####`, confirming this was a typo rather than an intentional deeper nesting.
…mal` README Replaces `#####` (5-hash) heading on line 35 with `####` (4-hash) so the constant-identifier sub-heading inside `## Usage` matches the convention used by 65 of 67 sibling packages (97% conformance). The C-API section within the same file (line 97) already uses `####`, and the float32 sibling (`constants/float32/smallest-subnormal`) uses `####`, confirming this was a typo rather than an intentional deeper nesting.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 21, 2026
##### heading-level typo in two @stdlib/constants/float64 READMEs
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
Cross-package drift analysis of
@stdlib/constants/float64identified two high-confidence mechanical corrections. Both files have an H5 (#####) heading for the constant-identifier sub-section inside## Usagewhere 65 of 67 sibling packages (97% conformance) and both float32 siblings use H4 (####).Namespace summary
package.jsonshape (top keys, scripts,keywords),manifest.jsonshape, README section structure and heading levels, README<section class="…">wrappers, README usage-block variable vslib/index.jsMAINvariable name, test/example file naming, module- and main-docblock JSDoc tags,lib/index.jsstructural conventions (MODULES/MAIN/EXPORTSmarkers), C header guard/define structure.package.jsontop keys (100%),manifest.jsonshape (100%, byte-identical across all 67 packages), C header structure (100%), constant-identifier sub-heading uses####(97%, this PR),## See AlsoREADME section presence (78%, excluded — auto-populated),dblkeyword (87%),doublekeyword (91%),float64keyword (85%),math/mathematicskeywords (84%).varprefix convention (52%FLOAT64_-prefixed vs 40% bare in both README and lib, 8% split — no convention to enforce).@stdlib/constants/float64/smallest-normalREADME.mdline 33: theFLOAT64_SMALLEST_NORMALidentifier sub-heading inside## Usageis rendered at H5 (##### FLOAT64_SMALLEST_NORMAL) instead of H4 (#### FLOAT64_SMALLEST_NORMAL). The C-API counterpart in the same file (line 91,#### STDLIB_CONSTANT_FLOAT64_SMALLEST_NORMAL) already uses H4, as does the float32 sibling — so the H5 here is internally inconsistent and a typo, not an intentional deeper nesting. 97% conformance (65/67) for####at this position across the namespace.@stdlib/constants/float64/smallest-subnormalREADME.mdline 35: identical shape tosmallest-normal.##### FLOAT64_SMALLEST_SUBNORMALinside## Usagewhere 65 of 67 siblings, the same file's C-API section at line 97, and the float32 sibling all use####. Same 97% conformance.Related Issues
None.
Questions
No.
Other
Validation
package.jsonandmanifest.jsonshapes, README heading-level lists, README<section class="…">wrappers, test/example filenames, C header structure.lib/index.jsfor each package: module-docblock and main-docblock JSDoc tag sets,MAINvar name,@examplevar name,// MODULES ///MAIN/EXPORTSsection presence.##### FLOAT64_SMALLEST_NORMALor##### FLOAT64_SMALLEST_SUBNORMAL; the 5-hash heading appears nowhere outside these two READMEs.pi,e,max, and both float32 siblings, confirming####is the convention at the structurally identical position and that##### → ####is the right repair.Deliberately excluded
## See AlsoREADME section (15 packages omit; section is generator-owned per project convention, content varies per package).float64keyword absent inexponent-bias,max/min-base{2,10}-exponent[-subnormal],precision— float32 siblings omitfloat32in the same slot;double/dblkeywords absent ingamma-lanczos-g,high-word-{abs,exponent,sign,significand}-mask,num-high-word-significand-bits,num-bytes,smallest-normal,smallest-subnormal— float32 siblings omitsingle/single-precisionin the same slots and instead use thefloat/floatN/Nbittriplet;math/mathematicskeywords absent inmax-safe-*,max-nth-*,min-safe-integer— float32 siblings omit; tagged as integer-bound constants by convention.@seeURL (would require choosing a Wikipedia/OEIS/Mathworld reference per constant);cbrt-eps,eps,sqrt-eps,fourth-root-eps,gamma-lanczos-g,glaisher-kinkelinREADME-vs-lib identifier mismatches (e.g.,EPSin README,FLOAT64_EPSILONin lib): pre-existing inconsistency mirrored inconstants/float32per PR chore: update examples and add keyword #12967; reconciling requires a maintainer call on the canonical spelling and whether to carry theFLOAT64_prefix in README usage blocks (52% prefixed vs 40% bare — no majority).varprefix convention (split 52/40);constants/float64/naninstats/strided/dnanmeanpn#11768, feat: addconstants/float64/inv-two-pi#8982 touchconstants/float64but do not modify either candidate file; no recent merged PR in the last 14 days touchessmallest-normal/README.mdorsmallest-subnormal/README.md.Cross-namespace tie-in
This run reuses the float32-sibling cross-check pattern from PR #12967 to drop intentional cross-namespace keyword omissions. The fix pattern "correct an H5 → H4 heading typo" is structurally identical to a propagation fix pattern; future runs can deduplicate by comparing heading-level distributions across precision-sibling namespaces.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as an automated cross-package API-drift detection run against the
@stdlib/constants/float64namespace. Drift was identified by extracting structural and semantic features from every package, computing a per-feature majority pattern (≥75% threshold), and filtering candidate corrections through a three-agent validation pass plus a sibling cross-check against@stdlib/constants/float32(PR #12967) to drop intentional cross-namespace deviations. A human will audit and promote the PR out of draft.@stdlib-js/reviewers
Generated by Claude Code