Repository navigation
docs: add empty intro and notes section wrappers - #15450
Merged
Merged
Conversation
…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
Contributor
Coverage ReportNo coverage information available. |
kgryte
approved these changes
Sep 23, 2026
math/base/tools READMEs
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:
introandnotesREADME section wrappers inmath/base/tools/continued-fractionandmath/base/tools/sum-series, the only two packages in the namespace that lack them.Namespace summary
math/base/toolspackage.jsontop-level key set,package.jsonfield values, README section wrappers, README section order, test/benchmark/example filenames,lib/index.jsbanner sets,returnKind, JSDoc@returnstype, JSDoc@paramdescriptions,@examplepresence, source-level dependency sets.errorConstruction(nothrowsite exists anywhere in the namespace); validation prologue (guard clauses present in 5/17 = 29.4%, absent in 12/17 = 70.6%);## Notesheading text (12/17 = 70.6%);lib/factory.jsand its pairedtest.factory.js/benchmark.factory.js(11/17 = 64.7%);test.main.js(6/17 = 35.3%).math/base/tools/continued-fractionAdds the empty
<section class="intro">/<!-- /.intro -->and<section class="notes">/<!-- /.notes -->wrappers tomath/base/tools/continued-fraction's README. 15 of 17 packages inmath/base/tools(88.2%) carry both wrappers per the package-generator template;evalpoly-compileandhermitepolyship them empty. No prose added or existing content touched; section order is now intro / usage / notes / examples / related / links.math/base/tools/sum-seriessum-series'sREADME.mdwas missing the<section class="intro">/<!-- /.intro -->and<section class="notes">/<!-- /.notes -->wrappers required by the package-generator template; 15 of 17 packages inmath/base/tools(88.2%) already carry both, includingevalpoly-compileandhermitepoly, 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
None.
Questions
No.
Other
Validation
Checked: structural feature extraction across all 17 members (file trees,
package.jsonkey 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.jsabsent incontinued-fractionandsum-series(present in 15/17 = 88.2%) — intentional. Both shiplib/basic.jsandlib/generators.jsand dispatch between them at load time viahasGeneratorSupport(); neither implementation is canonically "main", and both code paths are exercised by their tests.@returns {string}in the four*-compile*packages (numberin 13/17 = 76.5%) — intentional. These are code generators returning source strings; the contract is asserted indocs/types/index.d.tsand in tests.// MAIN //banner absent fromlib/index.jsin 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 suchlib/index.jsfiles inmath/base/specialcarry no// MAIN //banner.normhermitepolyf— excluded; the feature has no clear majority, and the NaN return is a documented contract shared withnormhermitepolyand asserted by four tests.polynomial/eval/evaluateabsent fromcontinued-fractionandsum-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.txtabsent from the four*-compile*packages (present in 13/17 = 76.5%) — generator-owned artifact; out of scope.licensefield"Apache-2.0 AND BSL-1.0"inevalrationalandevalrationalf("Apache-2.0"in 15/17 = 88.2%) — legal attribution, not drift.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code. It ran an automated cross-package drift audit over the
math/base/toolsnamespace: 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