Skip to content

docs: add examples section to _tools/pkgs/installed README - #14716

Draft
Planeshifter wants to merge 1 commit into
developfrom
claude/busy-mayer-kkbuwk
Draft

docs: add examples section to _tools/pkgs/installed README#14716
Planeshifter wants to merge 1 commit into
developfrom
claude/busy-mayer-kkbuwk

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • Populates the previously commented-out ## Examples section in the README for @stdlib/_tools/pkgs/installed, transcribing the package's existing examples/index.js and rewriting the require path to the public package name.

A cross-package structural scan of the 25 packages under @stdlib/_tools/pkgs found a JS-API-level ## Examples section in 24 of 25 (96%); installed was the sole outlier, shipping a runnable examples/index.js but 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

  • Members analyzed: 25 packages under @stdlib/_tools/pkgs.
  • Features analyzed: file tree, package.json and scripts key sets, README section presence/order, manifest.json shape, test/example file naming, error-construction style, JSDoc @example presence, public signatures, and validation prologues.
  • Features with a clear majority (≥75%): package-scaffolding file set (100%), package.json key set (100%), error construction via format (100%), README JS-API ## Examples section (96%).
  • Features excluded (no clear majority): README JS-API ## Notes section (64%); public signatures and validation prologues (heterogeneous internal tools).

installed

The installed package carried an empty, commented-out ## Examples placeholder despite shipping a complete examples/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

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?

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 ## Notes section at 64%), outliers reflecting genuine semantic differences (e.g. lib/validate.js presence, which tracks whether a tool accepts an options object), and any change that would require authoring new test logic.

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

This PR was authored by Claude Code running an automated cross-package documentation-consistency check over the @stdlib/_tools/pkgs namespace. The tooling identified that installed was the only package (of 25) missing a populated README Examples section, then transcribed the package's existing examples/index.js into the standard section format. The change is documentation-only.


@stdlib-js/reviewers


Generated by Claude Code

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
@stdlib-bot stdlib-bot added the Tools Issue or pull request related to project tooling. label Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tools Issue or pull request related to project tooling.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants