Skip to content

docs: add missing stub sections#11871

Merged
kgryte merged 5 commits intodevelopfrom
philipp/drift-array-base-assert-2026-05-01
May 2, 2026
Merged

docs: add missing stub sections#11871
kgryte merged 5 commits intodevelopfrom
philipp/drift-array-base-assert-2026-05-01

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

Description

Aligning outliers in array/base/assert with namespace majority patterns (random namespace pick, seed 20260501).

Namespace summary

  • Namespace: array/base/assert
  • Members analyzed: 26 (0 autogenerated, 0 excluded)
  • Structural features analyzed: file tree, package.json shape, README section markers, test/benchmark/example file naming
  • Semantic features analyzed: public signature, validation prologue, error construction, JSDoc shape, dependency set
  • Features with clear majority (≥75%): file tree (9 files in 26/26), top-level package.json keys (18 keys in 26/26), README <section class="intro|usage|examples|links|related"> (26/26), README <section class="notes"> (25/26 = 96%), README <section class="references"> (21/26 = 81%), @returns JSDoc tag type {boolean} (26/26), hasExample (26/26), validation prologue empty (26/26), error construction none (26/26)
  • Features without clear majority (excluded): __stdlib__ package.json key (14/26 = 54%), ## Notes markdown heading (9/26 = 35%), public signature shape (multiple groups, all <50% — semantic difference, not drift), benchmark filename (benchmark.js vs benchmark.length.js — reflects whether the function walks an array)

Outliers corrected

is-accessor-array

Adds empty <section class="notes"> and <section class="references"> placeholders to align with namespace siblings, where 96% (25/26) carry a notes section and 81% (21/26) carry a references section. Both sections are present in the overwhelming majority of array/base/assert packages and their absence here was an outlier.

is-booleanarray

Adds empty <section class="references"> placeholder to align with 81% of array/base/assert namespace siblings. Maintains structural consistency across the namespace.

is-complex-typed-array

Adds an empty <section class="references"> placeholder to align with 81% of array/base/assert siblings. Brings the package into conformance with the dominant documentation pattern across the namespace.

is-complex128array

Adds an empty <section class="references"> placeholder to align with the 81% of array/base/assert siblings that include this section. Keeps the package consistent with namespace conventions.

is-complex64array

Adds empty <section class="references"> placeholder to align with 81% of array/base/assert siblings. Ensures namespace consistency without altering package behavior.

Related Issues

None.

Questions

None.

Other

Validation

What was checked:

  • Structural feature extraction across all 26 namespace members (file tree, package.json keys, README HTML section markers, test/benchmark/example file names)
  • Semantic feature extraction across all 26 members (public signature, validation prologue, error construction, JSDoc shape, dependency set) — performed deterministically via static parsing rather than per-package agents, since the source files are uniformly templated and pattern-matching is reliable; logged in the local drift report
  • Three-agent drift validation: Agent 1 (semantic-review) skipped — drift is purely structural; Agent 2 (cross-reference) skipped — README placeholder additions cannot be referenced by tests or examples; Agent 3 (structural-review) confirmed all 6 (outlier, section) pairs as confirmed-drift

What was deliberately excluded:

  • Public-signature variation across the namespace — multiple legitimate shapes ((value), (x, y), (x, y, maxULP), (from, to), ()-with-factory) reflect genuine semantic differences and have no clear majority
  • Benchmark filename variation — benchmark.js (constant-time predicates) vs benchmark.length.js (array-walking predicates) reflects function complexity, not drift
  • __stdlib__ package.json key — 14/26 = 54%, below the 75% threshold

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 authored by Claude Code as part of an automated cross-package API drift detection routine: extract structural and semantic features from every package in a randomly selected namespace, compute the majority pattern for each feature at a 75% threshold, validate findings via review agents, and apply mechanical corrections to outliers. Each correction in this PR was independently verified to be a structural placeholder addition with no behavioral or test impact.


@stdlib-js/reviewers


Generated by Claude Code

claude added 5 commits May 1, 2026 04:23
…ventions

Added missing `<section class="notes">` placeholder (present in 96% of
siblings) and missing `<section class="references">` placeholder (present
in 81% of siblings).
…ntions

Added missing `<section class="references">` placeholder (present in 81%
of siblings).
…e conventions

Added missing `<section class="references">` placeholder (present in 81%
of siblings).
…nventions

Added missing `<section class="references">` placeholder (present in 81%
of siblings).
…ventions

Added missing `<section class="references">` placeholder (present in 81%
of siblings).
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
array/base/assert/is-accessor-array $\color{green}95/95$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}95/95$
$\color{green}+100.00%$
array/base/assert/is-booleanarray $\color{green}100/100$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}100/100$
$\color{green}+100.00%$
array/base/assert/is-complex-typed-array $\color{green}109/109$
$\color{green}+100.00%$
$\color{green}8/8$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}109/109$
$\color{green}+100.00%$
array/base/assert/is-complex128array $\color{green}100/100$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}100/100$
$\color{green}+100.00%$
array/base/assert/is-complex64array $\color{green}100/100$
$\color{green}+100.00%$
$\color{green}6/6$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}100/100$
$\color{green}+100.00%$

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

@Planeshifter Planeshifter changed the title style: align outliers in array/base/assert with namespace conventions docs: add missing stub sections May 1, 2026
@Planeshifter Planeshifter requested a review from kgryte May 1, 2026 22:15
@Planeshifter Planeshifter marked this pull request as ready for review May 1, 2026 22:16
@Planeshifter Planeshifter requested a review from a team May 1, 2026 22:16
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 1, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels May 2, 2026
@kgryte kgryte merged commit 394c99f into develop May 2, 2026
58 checks passed
@kgryte kgryte deleted the philipp/drift-array-base-assert-2026-05-01 branch May 2, 2026 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants