Skip to content

docs: consolidate @example blocks in string/base/stickycase#13150

Draft
Planeshifter wants to merge 1 commit into
developfrom
philipp/drift-string-base-2026-06-26
Draft

docs: consolidate @example blocks in string/base/stickycase#13150
Planeshifter wants to merge 1 commit into
developfrom
philipp/drift-string-base-2026-06-26

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • Consolidates three redundant module-level @example blocks in lib/node_modules/@stdlib/string/base/stickycase/lib/index.js into a single block sharing one require declaration. All three call sites (default p, p=0.2, p=0.8) are preserved.

string/base/stickycase

The module-level JSDoc in lib/index.js previously contained three separate @example blocks, each re-importing the package with its own var stickycase = require( ... ) line. Among the 59 leaf packages in @stdlib/string/base/, 58 (98%) place all module-level invocations inside a single @example block sharing one require declaration; stickycase was the only outlier. The fix preserves every invocation verbatim — only the redundant imports and block boundaries are removed.

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?

Conformance: 58/59 sibling packages (98%) use the consolidated style. No tests, examples, or downstream consumers reference the JSDoc block structure.

Checklist

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

This PR was prepared as part of an automated cross-package drift detection routine. Structural and JSDoc feature extraction across all 59 leaf packages in @stdlib/string/base/ identified stickycase's module-level @example layout as the sole deviation from the namespace's single-block convention. The proposed fix was validated by three independent agent reviews (semantic, cross-reference, structural) before being applied.


@stdlib-js/reviewers


Generated by Claude Code

Merge three redundant module-level `@example` blocks in
`lib/node_modules/@stdlib/string/base/stickycase/lib/index.js` into a
single block sharing one `require` declaration. All three call sites
(default `p`, `p=0.2`, `p=0.8`) are preserved verbatim.

The consolidated form matches the convention used by the other 58 of 59
leaf packages in `@stdlib/string/base/` (98% conformance), where each
module-level JSDoc contains exactly one `@example` block in which
multiple invocations follow a single shared `require`.

PR-URL:
Reviewed-by:
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
string/base/stickycase $\\color{green}118/118$
$\\color{green}+100.00\\%$
$\\color{green}10/10$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}118/118$
$\\color{green}+100.00\\%$

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants