From 1ad87c318e33e32451463d2f60b23cbb89b34311 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 28 Sep 2026 20:49:45 +0000 Subject: [PATCH 1/2] docs: use level-4 API headings in `remark-lint-expected-html-sections` Promote the `plugin()` and `plugin.factory( [options] )` signature headings inside the README usage section from level 3 to level 4. Level 4 is used at this position by 12 of 14 packages (86%) in `_tools/remark/plugins`, and by 6194 of 6200 stdlib package READMEs (99.90%) that carry an API heading inside their usage section. `remark-lint-eslint` exposes an identical `plugin()` plus `plugin.factory( [options] )` API and already documents both at level 4, so the deviation does not track a difference in API shape. The corrected condition is a primary signature heading at level 3 with no level-4 heading above it. Level-3 headings remain correct elsewhere as sub-grouping headings beneath a level-4 API heading. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_019GHyxM56Nqjq3iY7UZ4Tdq --- .../plugins/remark-lint-expected-html-sections/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/README.md index 4791ca298443..e0cf4b2a4016 100644 --- a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/README.md +++ b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections/README.md @@ -38,7 +38,7 @@ This plugin checks for the presence of required HTML sections in README.md files var plugin = require( '@stdlib/_tools/remark/plugins/remark-lint-expected-html-sections' ); ``` -### plugin() +#### plugin() A [remark][remark] plugin which validates the presence of expected HTML sections in README files. @@ -54,7 +54,7 @@ function done( error, file ) { } ``` -### plugin.factory( \[options] ) +#### plugin.factory( \[options] ) Returns a configured [remark][remark] plugin for validating expected HTML sections in README files. From f603dd4e5c9ef821423de0e14294e609dcac7521 Mon Sep 17 00:00:00 2001 From: Claude Date: Mon, 28 Sep 2026 20:49:54 +0000 Subject: [PATCH 2/2] docs: use a level-4 API heading in `remark-lint-html-section-structure` Promote the `sectionStructure()` signature heading inside the README usage section from level 3 to level 4. Level 4 is used at this position by 12 of 14 packages (86%) in `_tools/remark/plugins`, and by 6194 of 6200 stdlib package READMEs (99.90%) that carry an API heading inside their usage section. Sibling single-function plugins document their exported function the same way: `remark-lint-equations` uses `#### lint()` and `remark-namespace-toc` uses `#### insertTOC()`. This package exports a single plugin function of exactly that kind, and its usage section has no sub-headings, so nothing nests beneath the changed heading. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_019GHyxM56Nqjq3iY7UZ4Tdq --- .../remark/plugins/remark-lint-html-section-structure/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/README.md b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/README.md index 211e1f1fd261..f8a3f08fbbfe 100644 --- a/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/README.md +++ b/lib/node_modules/@stdlib/_tools/remark/plugins/remark-lint-html-section-structure/README.md @@ -42,7 +42,7 @@ This plugin validates the HTML section structure in README files, ensuring that: var sectionStructure = require( '@stdlib/_tools/remark/plugins/remark-lint-html-section-structure' ); ``` -### sectionStructure() +#### sectionStructure() Plugin to lint HTML section structure in README files.