docs: link [converts] to base package in two math/iter/special READMEs#12844
Draft
Planeshifter wants to merge 2 commits into
Draft
docs: link [converts] to base package in two math/iter/special READMEs#12844Planeshifter wants to merge 2 commits into
[converts] to base package in two math/iter/special READMEs#12844Planeshifter wants to merge 2 commits into
Conversation
…/deg2rad` README Adds the `[@stdlib/math/base/special/deg2rad]` link to the verb in the package's README summary line and Usage section description, matching the verb-link convention used by 95/97 sibling packages in `@stdlib/math/iter/special` (e.g. `ceil`, `floor`, `round`, `trunc`). The link reference is already defined in the README's links section; only the inline link was missing.
…/rad2deg` README Adds the `[@stdlib/math/base/special/rad2deg]` link to the verb in the package's README summary line and Usage section description, matching the verb-link convention used by 95/97 sibling packages in `@stdlib/math/iter/special` (e.g. `ceil`, `floor`, `round`, `trunc`). The link reference is already defined in the README's links section; only the inline link was missing.
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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
Adds the missing inline
[@stdlib/math/base/special/<name>]link to the README summary blockquote and Usage-section description in@stdlib/math/iter/special/deg2radand@stdlib/math/iter/special/rad2deg, matching the verb-link convention used by 95/97 (97.9%) of sibling packages in the namespace.Namespace summary
lib/node_modules/@stdlib/math/iter/special/.package.jsontop-level /scripts/directoriesshape, universal keywords, README H2 section list,docs/repl.txtsection order,lib/index.jsbody, JSDoc@param/@throws/@returnsshape (per arity),examples/index.jsPRNG choice, README inline link to the base function.iteratively(51/97 = 53%); package-levelmathematicskeyword (64/97 = 66%); README/JSDoc Notes "non-numeric (NaN)" bullet (consistent within-package but split across surfaces — out of scope for this routine).@stdlib/math/iter/special/deg2radThe README summary blockquote (the
>line under# iterDeg2rad) and the Usage-section description (the line right after#### iterDeg2rad( iterator )) were missing an inline markdown link to[@stdlib/math/base/special/deg2rad], despite the link reference being defined in the<section class="links">block. 95 of 97 sibling packages (98%) carry this link in both slots. Wraps the verbconvertsas[converts][@stdlib/math/base/special/deg2rad], matching the verb-link pattern used by theceil,floor,round, andtruncfamily.@stdlib/math/iter/special/rad2degSame drift, same shape: the summary blockquote under
# iterRad2degand the Usage-section description under#### iterRad2deg( iterator )were both missing the inline[@stdlib/math/base/special/rad2deg]link, while the reference itself was already defined in<section class="links">. Wraps the verbconvertsin both slots aswhich [converts][@stdlib/math/base/special/rad2deg] an angle from radians to degrees, matching the verb-link shape used by theceil/floor/round/truncfamily.Related Issues
None.
Questions
No.
Other
Validation
package.json/ README /docs/repl.txt/docs/types/index.d.ts/lib/index.js/lib/main.jsshape capture across all 97 members. 100% conformance on every set-valued structural feature except the inline-link feature corrected here.lib/main.jsJSDoc shape (param types, throws messages, returns type, example presence), public signatures, validation prologues, error construction, and require'd dependencies — every feature 100% conforming within its arity class (92 arity-1 + 5 arity-2). Per-package semantic agents were skipped in favor of the direct scan because the namespace is template-uniform and the per-package read would have surfaced no additional signal.needs-humancheck against tests, examples, and sibling-package docs) and sonnet structural-review (closest-cousin convention match) returnedconfirmed-driftfor both outliers. Semantic-review was skipped because the feature is purely structural (README content).Deliberately excluded
@stdlib/math/iter/special/pow— currently the subject of open PR docs: fix package-wide doc errors in twomath/iterpackages #12473 (different fix, but covered by the open-PR collision gate); no overlapping correction proposed in this PR.factorial/factorialln— the 2 packages whoseexamples/index.jsusesdiscreteUniforminstead ofuniform: this is a domain-driven choice (factorials are defined on non-negative integers) and was markedintentional-deviationand dropped.ceil/floor/round/truncfamily +cospi/sinpi— 14 packages whose JSDoc summary inlib/main.jsreadsReturns an iterator which {rounds|computes} ...rather than the majorityReturns an iterator which iteratively ...: phrasing matches each package's own README anddocs/repl.txt, so flipping to the majority would introduce a within-package inconsistency. Markedintentional-deviation.package.jsonkeywordmathematics(64/97 = 66%) — below the 75% majority threshold.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code on behalf of @Planeshifter as the output of an automated cross-package API-drift scan over
@stdlib/math/iter/special. Candidate corrections were derived from structural + programmatic-semantic majority votes across all 97 namespace members, gated by an open-PR / autogen / materiality pre-filter, and confirmed by two independent reviewer agents (opus cross-reference + sonnet structural-review) before commits were applied in the primary worktree. A maintainer will audit and promote the PR out of draft.@stdlib-js/reviewers
Generated by Claude Code