Repository navigation
docs: update aliases - #13490
Merged
Merged
docs: update aliases#13490
Conversation
…float64/gamma-lanczos-g` The exported identifier is `FLOAT64_GAMMA_LANCZOS_G`, and 61/67 (91%) of `@stdlib/constants/float64` sibling READMEs use an H1 title matching their export identifier. This README lagged behind, using the unprefixed `GAMMA_LANCZOS_G` in its H1, subsection header, and inline code samples. The `constants/float32/gamma-lanczos-g` sibling was aligned to the prefixed form previously. Bring the README into conformance. No source, test, example, or type declaration is touched. Co-Authored-By: Claude <noreply@anthropic.com>
…float64/fourth-root-eps` The exported identifier is `FLOAT64_FOURTH_ROOT_EPS`, and 61/67 (91%) of `@stdlib/constants/float64` sibling READMEs use an H1 title matching their export identifier. This README lagged behind, using the unprefixed `FOURTH_ROOT_EPS` in its H1, subsection header, and inline code samples. The `constants/float32/fourth-root-eps` sibling was aligned to the prefixed form previously. Bring the README into conformance. No source, test, example, or type declaration is touched. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
marked this pull request as ready for review
July 16, 2026 00:54
kgryte
approved these changes
Jul 16, 2026
FLOAT64_ in two @stdlib/constants/float64 packages
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:
@stdlib/constants/float64with the identifier actually exported fromlib/index.js, matching a namespace-wide convention already present in 91% of siblings and mirrored by theconstants/float32counterpart.Namespace summary
@stdlib/constants/float64.package.jsonshape, scripts,stdlibkeys,directories, keywords;manifest.jsonshape; README heading sequence; README H1 title vslib/index.jsexported identifier;lib/index.jsJSDoc tag set, section markers (// MAIN //,// EXPORTS //),@seeURLs, andrequire()graph;docs/repl.txt,docs/types/index.d.ts,test/test.js, andexamples/index.jsshape.package.jsontop-level key set (100%),directoriesandmanifest.jsonkey sets (100%),examples/,test/,docs/,include/,lib/file-name sets (100%),@type/@constant/@default/@module/@exampleJSDoc tag presence (100%), README H1 title matches exported identifier (91%, 61/67).Per outlier package
@stdlib/constants/float64/gamma-lanczos-gRename README references from the short form
GAMMA_LANCZOS_GtoFLOAT64_GAMMA_LANCZOS_Gto match the exported identifier inlib/index.js: six occurrences rewritten (H1,#### GAMMA_LANCZOS_Gsubsection header, four inline code samples), word-boundary regex leaves theSTDLIB_CONSTANT_FLOAT64_GAMMA_LANCZOS_GC-macro reference intact. Aligns with 61/67 (91%) of@stdlib/constants/float64sibling READMEs and matches the pattern already used byconstants/float32/gamma-lanczos-g(FLOAT32_GAMMA_LANCZOS_G). No source, test, example,docs/repl.txt, or.d.tsfile changed.@stdlib/constants/float64/fourth-root-epsRewrote six occurrences of the short-form
FOURTH_ROOT_EPSin the README (H1, the####subsection header, and four inline code samples) toFLOAT64_FOURTH_ROOT_EPS, matching the identifier exported fromlib/index.jsand aligning with theconstants/float32/fourth-root-epssibling and 61/67 (91%) of@stdlib/constants/float64READMEs. README-only; no source, test, example,docs/repl.txt, or.d.tschanges. Word-boundary regex, so theSTDLIB_CONSTANT_FLOAT64_FOURTH_ROOT_EPSC-macro reference is untouched.Related Issues
No.
Questions
No.
Other
Validation
Checked:
package.jsonshape and field values,manifest.jsonshape, README heading sequence and identifier usage,lib/index.jsJSDoc tag set and section markers,require()graph,docs/repl.txtanddocs/types/index.d.tsshape,test/test.jsandexamples/index.jsfilenames.cbrt-eps,eps,sqrt-eps) asneeds-humanbecause the code identifier ends in_EPSILONwhile the F32 sibling's README ends in_EPS, making the intended rename target ambiguous. Those three were dropped per the routine's advance criteria.Deliberately excluded:
@seeJSDoc tag absence in 11 packages (e.g.half-ln-two,ln-half,ln-ten,sqrt-half,sqrt-two) — the omission is mirrored in everyconstants/float32sibling and reflects packages without a canonical Wikipedia/OEIS reference. Same treatment applied in PR docs: tidy doc and C macro drift in@stdlib/constants/float32#12432 for the F32 side.float64,dbl,double,math,mathematics) in 28 flagged outliers — every case mirrors the matchingconstants/float32sibling's keyword set. Thedbl/doubleabsences also correspond to a coherent"64bit"-style keyword family (high-word-*,num-high-word-significand-bits,gamma-lanczos-g), not drift. Same treatment applied in PR chore: correct float64 keyword leftovers in@stdlib/constants/float32packages #11964 and PR docs: tidy doc and C macro drift in@stdlib/constants/float32#12432.## See AlsoREADME section variation — auto-populated by the package generator and explicitly out of scope per the routine's pre-validation gate.constants/float64/glaisher-kinkelin— the exported identifier isA(mathematical notation for the Glaisher–Kinkelin constant), notFLOAT64_GLAISHER; the F32 sibling was refactored toFLOAT32_GLAISHER, but changing the F64 export fromAis a JS-side rename and needs maintainer sign-off, not a drift correction.constants/float64/cbrt-eps,constants/float64/eps,constants/float64/sqrt-eps— the F32 siblings useFLOAT32_*_EPSin the README while exportingFLOAT32_*_EPSILON; on the F64 side the export is alsoFLOAT64_*_EPSILON. Whether the F64 README should mirror the F32 short-form (FLOAT64_*_EPS) or align with the actual_EPSILONexport is a maintainer judgment call, not mechanical drift.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored end-to-end by Claude Code as part of the cross-package drift-detection routine. The namespace (
@stdlib/constants/float64) was selected at random, structural and semantic features were extracted across all 67 members, majority patterns were computed at the 75% threshold, and three independent validation agents (two Opus semantic / cross-reference, one Sonnet structural-review) reviewed each candidate before it was applied. Two surgical, mechanical README-only corrections remain after that gate — both are unprefixed short-form identifiers rewritten to theFLOAT64_*form that already matches the export and the siblingconstants/float32README. A human should verify the changes before merging.@stdlib-js/reviewers
Generated by Claude Code