docs: fix wording and indirection in math/base/assert/uint32-is-pow2#12854
Draft
Planeshifter wants to merge 1 commit into
Draft
docs: fix wording and indirection in math/base/assert/uint32-is-pow2#12854Planeshifter wants to merge 1 commit into
math/base/assert/uint32-is-pow2#12854Planeshifter wants to merge 1 commit into
Conversation
Replaces "whether" with "if" in package summary, README blockquote, README Usage and C APIs sections, JSDoc summaries in `lib/main.js`, `lib/index.js`, `lib/native.js`, and `docs/types/index.d.ts` to match the namespace convention (34/35 siblings use "Test if"/"Tests if" in each location). Renames the `lib/index.js` import variable from `isPow2Uint32` to `main` and updates the corresponding `module.exports` to match the indirection pattern used by 34/35 siblings. The exported function is unchanged. `docs/repl.txt` left untouched per generator-owned exclusion. https://claude.ai/code/session_01PZXpkkqMMffNV6CWutMWRP
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
This pull request:
@stdlib/math/base/assert/uint32-is-pow2from "Test whether"/"Tests whether" to "Test if"/"Tests if" acrosspackage.json,README.md(blockquote, Usage, C APIs),lib/index.js,lib/main.js,lib/native.js, anddocs/types/index.d.ts. The convention is used by 34/35 sibling packages in the namespace (97% conformance per location; 23/24 for the C APIs narrative).lib/index.jsimport variable fromisPow2Uint32tomainand updates the correspondingmodule.exportsto thevar main = require( './main.js' ); module.exports = main;indirection pattern used by 34/35 siblings (97% conformance). The exported function is unchanged.Namespace summary
uint32-is-pow2## See Also(74%),## C APIs(69%),## Notes(37%) — excluded from drift analysisbooleanreturn, singlex: number/integer32/uinteger32parameter, no validation prologue, no thrown errors)uint32-is-pow2Sole outlier in the namespace. The package predates the namespace-wide normalization to
"Test if ..."phrasing and thevar mainindirection. The proposed corrections are pure docstring / local-identifier edits — no signature, behavior, or test expectation changes.docs/repl.txtis left untouched as a generator-owned file.Validation
Three independent agent reviews confirmed all nine items as unintentional drift:
module.exportsrename is internal-only — test files declare their own localvar isPow2Uint32 = require('./../lib'));Deliberately excluded:
is-coprimemissing C-implementation files — open PR feat: add C implementation formath/base/assert/is-coprime#4169 is adding the C implementation.is-negative-integerfmissingdocs/repl.txt— generator-owned.src/addon.cpp+src/<name>.cinstead ofsrc/addon.c+src/main.c— non-mechanical refactor; warrants a separate maintainer pass.is-composite,is-coprime,is-primeJSDoc summary "Returns a boolean ..." vs majority "Tests if ..." — plausibly intentional for number-theoretic predicates; needs human judgment.math/base/assert/docs/types/index.d.ts— outside per-package scope.Related Issues
No.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code running a cross-package drift detection routine on
@stdlib/math/base/assert. The routine extracted structural and semantic features per package, identifieduint32-is-pow2as the sole outlier on nine related stylistic features (≥75% conformance per feature), and three independent agent reviews confirmed each item as unintentional drift before any edits were applied.@stdlib-js/reviewers
Generated by Claude Code