Skip to content

docs: fix heading levels - #15939

Merged
kgryte merged 8 commits into
developfrom
claude/cool-johnson-cvfk43
Oct 12, 2026
Merged

kgryte merged 8 commits into
developfrom
claude/cool-johnson-cvfk43

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • changes ## Notes to ### Notes in the C APIs section of eight napi READMEs, so the heading nests under ## C APIs like the existing ### Usage subsection.

Namespace summary. @stdlib/napi has 53 members and none are autogenerated. Seven structural features were analyzed: file tree, package.json keys, package.json scripts/stdlib keys, manifest.json keys, keywords, README sections, and test/benchmark/example file names. Every feature has a clear majority (at least 75%). The JS sources (lib/main.js, lib/index.js, lib/browser.js) are identical across all 53 packages apart from the package name, so they show no semantic drift.

napi/argv-complex128array, napi/argv-complex64array, napi/argv-int32, napi/argv-int64, napi/argv-strided-complex128array, napi/argv-strided-complex64array, napi/argv-uint32, napi/argv-uint64

The C API notes heading was at level two, which takes it out of the ## C APIs section. ### Usage sits at level three in 100% of napi siblings. Across stdlib, READMEs with a C APIs section use ### Notes for C API notes in 74 of 82 cases, and these eight packages are the remaining 8. This is a one-line heading change per package and does not change any content.

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.

Validation. Structural features were extracted for all 53 packages. The JS sources were compared by normalized content hash. Each candidate was then reviewed for structural applicability and checked against tooling and docs that reference it. Remark lint rules check <section> classes, not heading depth. Nothing links to these #notes anchors, and the JS notes sections are untouched.

Deliberately excluded:

  • napi/argv and napi/export lack binding.gyp, include.gypi, src/, lib/native.js, gypfile and directories.src. They are header-only macro packages, so this is intentional.
  • napi/argv-dataview-cast lacks src/main.c. It is header-only (its manifest has an empty src), so this is intentional.
  • napi/export is missing the utilities and utils keywords. This was dropped because it is a low-materiality metadata-only change.

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 written primarily by Claude Code as part of an automated cross-package drift-detection run.


🤖 Generated with Claude Code

https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i


Generated by Claude Code

claude added 8 commits October 6, 2026 16:38
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
…rray`

Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
…ray`

Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
Changed `## Notes` to `### Notes` within the C APIs section so the heading nests beneath `## C APIs` alongside `### Usage` (`### Usage` present in 100% of `napi` siblings; `### Notes` used for C API notes in 74 of 82 READMEs stdlib-wide, with the remaining 8 being this and its `napi` siblings).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01ChU3fyfvjayXEWk3ZKbg5i
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
napi/argv-complex128array $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
napi/argv-complex64array $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
napi/argv-int32 $\\color{green}146/146$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}146/146$
$\\color{green}+100.00\\%$
napi/argv-int64 $\\color{green}146/146$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}146/146$
$\\color{green}+100.00\\%$
napi/argv-strided-complex128array $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
napi/argv-strided-complex64array $\\color{green}156/156$
$\\color{green}+100.00\\%$
$\\color{green}8/8$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}156/156$
$\\color{green}+100.00\\%$
napi/argv-uint32 $\\color{green}146/146$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}146/146$
$\\color{green}+100.00\\%$
napi/argv-uint64 $\\color{green}146/146$
$\\color{green}+100.00\\%$
$\\color{green}5/5$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}146/146$
$\\color{green}+100.00\\%$

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

@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Oct 12, 2026
@kgryte
kgryte marked this pull request as ready for review October 12, 2026 00:23
@kgryte
kgryte requested a review from a team October 12, 2026 00:23
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 12, 2026
@kgryte kgryte changed the title docs: fix C API notes heading level in napi/argv-* READMEs docs: fix heading levels Oct 12, 2026
@kgryte
kgryte merged commit bf33e96 into develop Oct 12, 2026
50 checks passed
@kgryte
kgryte deleted the claude/cool-johnson-cvfk43 branch October 12, 2026 00:24
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Oct 12, 2026
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