Skip to content

docs: add empty intro and notes section wrappers - #15450

Merged
kgryte merged 2 commits into
developfrom
philipp/drift-math-base-tools-2026-09-23
Sep 23, 2026
Merged

kgryte merged 2 commits into
developfrom
philipp/drift-math-base-tools-2026-09-23

Conversation

@Planeshifter

Copy link
Copy Markdown
Member

Description

What is the purpose of this pull request?

This pull request:

  • restores the empty intro and notes README section wrappers in math/base/tools/continued-fraction and math/base/tools/sum-series, the only two packages in the namespace that lack them.

Namespace summary

  • Namespace: math/base/tools
  • Members analyzed: 17 (no autogenerated packages)
  • Majority threshold: ⌈17 × 0.75⌉ = 13 (≥76.5%)
  • Features with a clear majority: file tree, package.json top-level key set, package.json field values, README section wrappers, README section order, test/benchmark/example filenames, lib/index.js banner sets, returnKind, JSDoc @returns type, JSDoc @param descriptions, @example presence, source-level dependency sets.
  • Features excluded for want of a clear majority: errorConstruction (no throw site exists anywhere in the namespace); validation prologue (guard clauses present in 5/17 = 29.4%, absent in 12/17 = 70.6%); ## Notes heading text (12/17 = 70.6%); lib/factory.js and its paired test.factory.js/benchmark.factory.js (11/17 = 64.7%); test.main.js (6/17 = 35.3%).

math/base/tools/continued-fraction

Adds the empty <section class="intro">/<!-- /.intro --> and <section class="notes">/<!-- /.notes --> wrappers to math/base/tools/continued-fraction's README. 15 of 17 packages in math/base/tools (88.2%) carry both wrappers per the package-generator template; evalpoly-compile and hermitepoly ship them empty. No prose added or existing content touched; section order is now intro / usage / notes / examples / related / links.

math/base/tools/sum-series

sum-series's README.md was missing the <section class="intro">/<!-- /.intro --> and <section class="notes">/<!-- /.notes --> wrappers required by the package-generator template; 15 of 17 packages in math/base/tools (88.2%) already carry both, including evalpoly-compile and hermitepoly, which ship them empty. Both wrappers are added empty here — no prose invented, no existing line touched. The README now reads intro / usage / notes / examples / related / links, consistent with the rest of the namespace.

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? This may include screenshots, references, and/or implementation notes.

Validation

Checked: structural feature extraction across all 17 members (file trees, package.json key sets and values, keywords, README headings and section wrappers, test/benchmark/example filenames, source banner conventions); semantic feature extraction per package (public signature, return kind, validation prologue, error construction, JSDoc shape, source-level dependencies); and a three-agent review of every candidate correction before any edit.

Deliberately excluded, with the reason each was dropped:

  • lib/main.js absent in continued-fraction and sum-series (present in 15/17 = 88.2%) — intentional. Both ship lib/basic.js and lib/generators.js and dispatch between them at load time via hasGeneratorSupport(); neither implementation is canonically "main", and both code paths are exercised by their tests.
  • JSDoc @returns {string} in the four *-compile* packages (number in 13/17 = 76.5%) — intentional. These are code generators returning source strings; the contract is asserted in docs/types/index.d.ts and in tests.
  • // MAIN // banner absent from lib/index.js in the four *-compile* packages (present in 13/17 = 76.5%) — intentional. Those files are bare re-exports with no statement to place under the banner; repo-wide, 292 such lib/index.js files in math/base/special carry no // MAIN // banner.
  • Guard prologue in normhermitepolyf — excluded; the feature has no clear majority, and the NaN return is a documented contract shared with normhermitepoly and asserted by four tests.
  • Keywords polynomial/eval/evaluate absent from continued-fraction and sum-series (present in 15/17 = 88.2%) — intentional. Neither package evaluates a polynomial; the keyword majority reflects the shared domain of the other 15.
  • docs/repl.txt absent from the four *-compile* packages (present in 13/17 = 76.5%) — generator-owned artifact; out of scope.
  • license field "Apache-2.0 AND BSL-1.0" in evalrational and evalrationalf ("Apache-2.0" in 15/17 = 88.2%) — legal attribution, not drift.

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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

This PR was written primarily by Claude Code. It ran an automated cross-package drift audit over the math/base/tools namespace: structural and semantic features were extracted from all 17 member packages, a per-feature majority was computed at a 75% threshold, and every candidate correction was reviewed by three independent agents before any edit was applied. Seven of the nine candidate corrections were rejected as intentional deviations and are listed under "Other" above; only the two README section-wrapper additions survived. The applied diff is 24 added lines across two README files, with no existing line modified.


🤖 Generated with Claude Code

https://claude.ai/code/session_018ucqjMGaJTh16EHQt7DFYh


Generated by Claude Code

…s/continued-fraction`

Added empty `<section class="intro">` wrapper with `<!-- /.intro -->` close
marker (present in 15/17 = 88.2% of namespace siblings); added empty
`<section class="notes">` wrapper with `<!-- /.notes -->` close marker
(present in 15/17 = 88.2% of namespace siblings).

Both wrappers are scaffold placeholders and are left empty, matching the
package-generator README template and the empty wrappers already shipped by
siblings such as `evalpoly-compile` and `hermitepoly`. The section sequence
now reads intro / usage / notes / examples / related / links, identical to
the namespace majority. No prose was invented and no existing lines changed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018ucqjMGaJTh16EHQt7DFYh
…s/sum-series`

Added empty `<section class="intro">` wrapper with `<!-- /.intro -->` close
marker (present in 15/17 = 88.2% of namespace siblings); added empty
`<section class="notes">` wrapper with `<!-- /.notes -->` close marker
(present in 15/17 = 88.2% of namespace siblings).

Both wrappers are scaffold placeholders and are left empty, matching the
package-generator README template and the empty wrappers already shipped by
siblings such as `evalpoly-compile` and `hermitepoly`. The section sequence
now reads intro / usage / notes / examples / related / links, identical to
the namespace majority. No prose was invented and no existing lines changed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018ucqjMGaJTh16EHQt7DFYh
@stdlib-bot stdlib-bot added the Math Issue or pull request specific to math functionality. label Sep 23, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

No coverage information available.

@kgryte
kgryte marked this pull request as ready for review September 23, 2026 09:02
@kgryte
kgryte requested a review from a team September 23, 2026 09:02
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Sep 23, 2026
@kgryte kgryte changed the title docs: add empty intro and notes section wrappers to two math/base/tools READMEs docs: add empty intro and notes section wrappers Sep 23, 2026
@kgryte
kgryte merged commit df5f5ec into develop Sep 23, 2026
50 checks passed
@kgryte
kgryte deleted the philipp/drift-math-base-tools-2026-09-23 branch September 23, 2026 09:03
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Sep 23, 2026
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. Math Issue or pull request specific to math functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants