Skip to content

docs: document exported constants#12371

Merged
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-05-30
May 30, 2026
Merged

docs: document exported constants#12371
kgryte merged 1 commit into
developfrom
philipp/fix-propagation-2026-05-30

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request propagates fixes merged to develop between 2026-05-29 21:55:51 UTC and 2026-05-30 10:20:09 UTC to sibling packages.

Document the exported bool singleton in assert/is-big-endian and assert/is-little-endian by adding a JSDoc constant block (@constant, @type {boolean}) to the assignment in the // MAIN // section. Remove the now-vacuous // VARIABLES // sections and suppress the vars-on-top ESLint rule at the assignment site. Propagates the fix introduced for os/num-cpus.

Source commit: 5e64030 ("docs: document exported constant in os/num-cpus")

Target packages:

  • @stdlib/assert/is-big-endian
  • @stdlib/assert/is-little-endian

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

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 via module.exports = X; — across lib/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.js and constants/float32/pinf/lib/index.js match the structural signature but were flagged needs-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 float v. A mechanical propagation would create overlapping documentation; the correct fix is a deliberate restructure of the JSDoc placement, not part of this run.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was authored by Claude Code as part of the automated fix-propagation routine: it identified candidate sibling sites for a recent develop fix, 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

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.
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
assert/is-big-endian $\color{green}149/149$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}149/149$
$\color{green}+100.00\%$
assert/is-little-endian $\color{green}149/149$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}149/149$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

@Planeshifter Planeshifter marked this pull request as ready for review May 30, 2026 15:41
@Planeshifter Planeshifter requested a review from a team May 30, 2026 15:41
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 30, 2026
@Planeshifter Planeshifter requested a review from kgryte May 30, 2026 15:41
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 30, 2026
@kgryte kgryte changed the title docs: document exported constants in assert/is-{big,little}-endian docs: document exported constants May 30, 2026
@kgryte kgryte merged commit 2c9a456 into develop May 30, 2026
54 checks passed
@kgryte kgryte deleted the philipp/fix-propagation-2026-05-30 branch May 30, 2026 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants