docs: document exported constants#12371
Merged
Merged
Conversation
Propagates fix from 5e64030 ("docs: document exported constant in `os/num-cpus`") to sibling packages whose exported singleton constant was declared as an empty `var bool;` in `// VARIABLES //` and assigned later in `// MAIN //` without a JSDoc constant block.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
May 30, 2026
assert/is-{big,little}-endian
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 propagates fixes merged to
developbetween 2026-05-29 21:55:51 UTC and 2026-05-30 10:20:09 UTC to sibling packages.Document the exported
boolsingleton inassert/is-big-endianandassert/is-little-endianby adding a JSDoc constant block (@constant,@type {boolean}) to the assignment in the// MAIN //section. Remove the now-vacuous// VARIABLES //sections and suppress thevars-on-topESLint rule at the assignment site. Propagates the fix introduced foros/num-cpus.Source commit:
5e64030("docs: document exported constant inos/num-cpus")Target packages:
@stdlib/assert/is-big-endian@stdlib/assert/is-little-endianRelated Issues
None.
Questions
No.
Other
Validation. Candidate sites were enumerated by structurally matching the source pattern — an empty
var X;declaration in// VARIABLES //paired with a later top-level assignment in// MAIN //of a value exported viamodule.exports = X;— acrosslib/node_modules/@stdlib/**/lib/{main,index}.js, excluding internal tooling under_tools/. Each candidate was independently confirmed by two validation passes that read the target file in full, followed by an adaptation pass producing the per-site patch and a style-consistency pass verifying JSDoc layout,@type, and description alignment with the file's existing module-level documentation.Deliberately excluded.
constants/float32/ninf/lib/index.jsandconstants/float32/pinf/lib/index.jsmatch the structural signature but were flaggedneeds-human: each file already carries a@constant/@type {number}JSDoc block attached to an intermediate uint32 bit-pattern (FLOAT32_NINF/FLOAT32_PINF) rather than to the exported floatv. A mechanical propagation would create overlapping documentation; the correct fix is a deliberate restructure of the JSDoc placement, not part of this run.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 the automated fix-propagation routine: it identified candidate sibling sites for a recent
developfix, independently validated the defect at each site, produced and style-checked the patches, and applied them mechanically. A human should verify the changes before merging.Generated by Claude Code