Skip to content

docs: align JS API subheadings to H4 in stats/strided/dnanrangeabs#11957

Open
Planeshifter wants to merge 1 commit intodevelopfrom
claude/inspiring-curie-gXZLb
Open

docs: align JS API subheadings to H4 in stats/strided/dnanrangeabs#11957
Planeshifter wants to merge 1 commit intodevelopfrom
claude/inspiring-curie-gXZLb

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • Demotes two JS-API subheadings in lib/node_modules/@stdlib/stats/strided/dnanrangeabs/README.md (### dnanrangeabs( … ) and ### dnanrangeabs.ndarray( … )) from H3 to H4, matching the heading level used by 238/239 (99.6%) sibling packages in stats/strided for function-signature subheadings nested under ## Usage.

stats/strided/dnanrangeabs

The JS Usage block in dnanrangeabs/README.md was the lone outlier in the namespace using ### for the function-signature subheadings. Every other stats/strided package places these subheadings at ####, immediately under the ## Usage H2. The fix is purely structural: two heading lines, no behaviour or content changes.

Related Issues

Does this pull request have any related issues?

No.

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.

Conformance: #### for JS Usage subheadings — 238/239 = 99.6% of stats/strided non-aggregator packages. The aggregator package stats/strided/distances was excluded from the vote because it is structurally distinct (a namespace re-export, not a function package).

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 a cross-package API drift detection routine that compares structural features across all packages in a stdlib namespace, identifies the majority pattern per feature, and proposes mechanical corrections for outliers. The drift was detected by extracting H2/H3/H4 heading levels from every README.md under lib/node_modules/@stdlib/stats/strided/; the fix demotes two subheadings so they match the convention shared by 238 sibling packages.


@stdlib-js/reviewers


Generated by Claude Code

Demote the `### dnanrangeabs( … )` and `### dnanrangeabs.ndarray( … )`
JS-API subheadings nested under `## Usage` to `####`, matching the
heading level used by 238/239 (99.6%) sibling packages in
`stats/strided`. The H3 levels in the JS Usage block were inconsistent
with the convention applied uniformly across the namespace.
@stdlib-bot stdlib-bot added the Statistics Issue or pull request related to statistical functionality. label May 6, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/strided/dnanrangeabs $\color{green}388/388$
$\color{green}+100.00%$
$\color{green}33/33$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}388/388$
$\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 6, 2026 00:28
@Planeshifter Planeshifter requested review from a team and kgryte May 6, 2026 00:28
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs Review A pull request which needs code review. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants