docs: add examples section to _tools/pkgs/installed README - #14716
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: add examples section to _tools/pkgs/installed README#14716Planeshifter wants to merge 1 commit into
_tools/pkgs/installed README#14716Planeshifter wants to merge 1 commit into
Conversation
Populate the previously commented-out `## Examples` section in the README for `_tools/pkgs/installed`, transcribing the package's existing `examples/index.js` and rewriting the require path to the public package name. A JS-API-level Examples section is present in 24 of 25 (96%) sibling packages under `_tools/pkgs`; `installed` was the sole outlier, carrying an empty placeholder despite shipping a runnable example file. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JsYoEEpvcPyy7QW4LTsyvD
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:
## Examplessection in the README for@stdlib/_tools/pkgs/installed, transcribing the package's existingexamples/index.jsand rewriting the require path to the public package name.A cross-package structural scan of the 25 packages under
@stdlib/_tools/pkgsfound a JS-API-level## Examplessection in 24 of 25 (96%);installedwas the sole outlier, shipping a runnableexamples/index.jsbut leaving the README section as an empty, commented-out placeholder. The added section matches the sibling convention (e.g.@stdlib/_tools/pkgs/deps) verbatim.Namespace summary
@stdlib/_tools/pkgs.package.jsonandscriptskey sets, README section presence/order,manifest.jsonshape, test/example file naming, error-construction style, JSDoc@examplepresence, public signatures, and validation prologues.package.jsonkey set (100%), error construction viaformat(100%), README JS-API## Examplessection (96%).## Notessection (64%); public signatures and validation prologues (heterogeneous internal tools).installedThe
installedpackage carried an empty, commented-out## Examplesplaceholder despite shipping a completeexamples/index.js. The other 24 packages under@stdlib/_tools/pkgs(96%) document their example inline. This populates the section by transcribing the existing example and rewriting the require path to@stdlib/_tools/pkgs/installed. No source, signature, or test behavior changes.Related Issues
None.
Questions
No.
Other
Validation performed: structural feature extraction across all 25 sibling packages; error-construction and JSDoc scans over package sources; and a two-agent drift review (cross-reference + structural) confirming the fix is mechanical, documentation-only, and free of any test/example cascade. Deliberately excluded from this PR: features without a clear 75% majority (e.g. the README
## Notessection at 64%), outliers reflecting genuine semantic differences (e.g.lib/validate.jspresence, which tracks whether a tool accepts an options object), and any change that would require authoring new test logic.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running an automated cross-package documentation-consistency check over the
@stdlib/_tools/pkgsnamespace. The tooling identified thatinstalledwas the only package (of 25) missing a populated README Examples section, then transcribed the package's existingexamples/index.jsinto the standard section format. The change is documentation-only.@stdlib-js/reviewers
Generated by Claude Code