docs: consolidate @example blocks in string/base/stickycase#13150
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: consolidate @example blocks in string/base/stickycase#13150Planeshifter wants to merge 1 commit into
@example blocks in string/base/stickycase#13150Planeshifter wants to merge 1 commit into
Conversation
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:
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
@exampleblocks inlib/node_modules/@stdlib/string/base/stickycase/lib/index.jsinto a single block sharing onerequiredeclaration. All three call sites (defaultp,p=0.2,p=0.8) are preserved.string/base/stickycaseThe module-level JSDoc in
lib/index.jspreviously contained three separate@exampleblocks, each re-importing the package with its ownvar stickycase = require( ... )line. Among the 59 leaf packages in@stdlib/string/base/, 58 (98%) place all module-level invocations inside a single@exampleblock sharing onerequiredeclaration;stickycasewas the only outlier. The fix preserves every invocation verbatim — only the redundant imports and block boundaries are removed.Related Issues
None.
Questions
No.
Other
Conformance: 58/59 sibling packages (98%) use the consolidated style. No tests, examples, or downstream consumers reference the JSDoc block structure.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
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/identifiedstickycase's module-level@examplelayout as the sole deviation from the namespace'ssingle-blockconvention. The proposed fix was validated by three independent agent reviews (semantic, cross-reference, structural) before being applied.@stdlib-js/reviewers
Generated by Claude Code