docs: align description openers in three array/base/assert cast packages#12207
Closed
Planeshifter wants to merge 3 commits into
Closed
docs: align description openers in three array/base/assert cast packages#12207Planeshifter wants to merge 3 commits into
array/base/assert cast packages#12207Planeshifter wants to merge 3 commits into
Conversation
…type-cast` Reword the README tagline, `package.json` description, and `docs/repl.txt` opener from "Determine whether/if" and "Returns a boolean indicating whether" to "Test if" / "Tests if", matching the namespace convention used in 23 of 26 sibling packages (88.5%).
Reword the README tagline, `package.json` description, and `docs/repl.txt` opener from "Determine whether/if" and "Returns a boolean indicating whether" to "Test if" / "Tests if", matching the namespace convention used in 23 of 26 sibling packages (88.5%).
…pe-cast` Reword the README tagline, `package.json` description, and `docs/repl.txt` opener from "Determine whether/if" and "Returns a boolean indicating whether" to "Test if" / "Tests if", matching the namespace convention used in 23 of 26 sibling packages (88.5%).
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
requested changes
May 20, 2026
kgryte
left a comment
Member
There was a problem hiding this comment.
None of the changes in this PR are necessary. Closing...
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/array/base/assert/so that they read in the same voice as the rest of the namespace.Namespace summary
@stdlib/array/base/assert/README.mdtagline opener —Test if(23/26 = 88.5%)package.jsondescriptionopener —Test if(23/26 = 88.5%)docs/repl.txtfirst descriptive line opener —Tests if(23/26 = 88.5%)lib/main.jsJSDoc opener (Tests whether11 /Tests if8 /Returns a7),lib/index.js@moduleopener (12/11/3),docs/types/index.d.tsJSDoc opener (11/11/3), README section sequence (17/9 split on the optional## Notessection), and benchmark file naming (driven by single-value-vs-array function shape, not drift).Per outlier package
array/base/assert/is-mostly-safe-data-type-castRewrites the tagline,
package.jsondescription, anddocs/repl.txtopening line to use"Test if ..."/"Tests if ..."phrasing, matching 23 of 26 sibling packages (88.5%). No code, signature, or behavioral changes.README.mdtagline:"Determine whether ..."→"Test if ..."package.jsondescription:"Determine if ..."→"Test if ..."docs/repl.txtfirst line:"Returns a boolean indicating whether ..."→"Tests if ..."array/base/assert/is-safe-data-type-castRewords documentation to use "Test if ..." / "Tests if ..." phrasing, consistent with 23 of 26 sibling packages (88.5%). No code, signatures, or behavior changed.
README.mdtagline: "Determine whether ..." → "Test if ..."package.jsondescription: "Determine if ..." → "Test if ..."docs/repl.txtopening line: "Returns a boolean indicating whether ..." → "Tests if ..."array/base/assert/is-same-kind-data-type-castStandardizes documentation phrasing to match the convention used by 23 of 26 sibling packages (88.5%), which prefix descriptions with "Test if" rather than "Determine whether/if". No code, signatures, or behavior changed.
README.mdtagline: "Determine whether ..." → "Test if ..."package.jsondescription: "Determine if ..." → "Test if ..."docs/repl.txtopening line: "Returns a boolean indicating whether ..." → "Tests if ..."Related Issues
No.
Questions
No.
Other
Validation
package.jsonkey sets,README.mdsection sequences,manifest.jsonshape, and test/benchmark/example filenames were collected for all 26 members; no structural outlier survived filtering (thecontainspackage'sfactory.jsis a legitimate semantic difference, and thebenchmark.jsvsbenchmark.length.jssplit tracks single-value vs array-input function shape).lib/main.jsandlib/index.jswas parsed for public signature, return kind, validation prologue, error construction, JSDoc shape, and@stdlib/*source-level dependencies. All 26 members returnbooleanwith no validation prologue (these arebaseinternal helpers, by design).lib/node_modules/@stdlib/) confirmed that the deviating phrases appear only in the three outliers' own files (no fixture, test, or sibling-package README embeds them); a structural review confirmed that the majority opener applies uniformly across 7 sampled conforming packages and reads naturally on the cast packages.lib/main.jsJSDoc,lib/index.js@moduleblock, anddocs/types/index.d.ts(no clear majority opener in the namespace); the README## Notessection sequence split (no clear majority); per-packagekeywordsarrays (intentionally diverge by package subject);is-accessor-array@param {Object}(the function dereferences.getand would crash onnull/undefined, so the restrictive type hint is semantically appropriate for abasehelper).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was prepared by Claude Code. It surveyed all 26 packages under
@stdlib/array/base/assert/, identified the three documentation surfaces with a ≥75% majority opener, and rewrote the three outlier packages' leading phrases to match. Each correction was reviewed by independent semantic, cross-reference, and structural validation passes before any file was modified. No behavior, signatures, or test expectations were changed.Generated by Claude Code