docs: update descriptions#13013
Merged
Merged
Conversation
Update the `description` field in `package.json` to match the JSDoc description on the package's public function and to align with the namespace convention used by 24 of 27 sibling packages (88.9%), which prefix their descriptions with "Return a ".
…-path` Update the `description` field in `package.json` to match the JSDoc description on the package's public function and to align with the namespace convention used by 24 of 27 sibling packages (88.9%), which prefix their descriptions with "Return a ".
Update the `description` field in `package.json` to match the JSDoc description on the package's public function and to align with the namespace convention used by 24 of 27 sibling packages (88.9%), which prefix their descriptions with "Return a ".
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Jun 21, 2026
package.json descriptions in regexp namespace
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:
Return ato thedescriptionfield of threepackage.jsonfiles in the@stdlib/regexpnamespace so they match each package's own JSDoc and the convention used by the rest of the namespace.Namespace summary
@stdlib/regexppackage.jsonkeys,package.jsondescription,package.jsonkeywords,scriptskeys,manifest.jsonshape, README headings, test/benchmark/example filenames, JSDoc shape (@param/@returns/@throws/@example), error-construction style, validation prologue, and per-packagelib/dependencies.package.jsondescriptionprefix — 24/27, 88.9%).## See Alsoexcluded as generator-owned),test/test.main.jspresence (missing inreviverandto-json, both pure re-exports oflib/main.js, so atest.main.jswould duplicatetest.jsverbatim), andregexkeyword (missing inreviverandto-json, both of which follow the utility-package keyword template rather than the regex-producer template).Error, 4 throwTypeError; the variance reflects an open stdlib-wide convention question and is not safe to normalize as a metadata fix because it is observable behavior).@stdlib/string/format. No normalization needed.@stdlib/regexp/duration-stringThe package's
descriptionfield readRegular expression to match a duration string., while the public function's JSDoc readsReturns a regular expression to match a duration string.and 24 of 27 namespace siblings (88.9%) use theReturn a regular expression to ...prefix in theirdescription. Normalized the field so the package metadata matches both the function's own docstring and the surrounding convention.@stdlib/regexp/extended-length-pathThe
descriptionfield readRegular expression to detect an extended-length path., out of step with the function's JSDoc (Returns a regular expression that matches an extended-length path.) and with the namespace convention (24/27 = 88.9%). Normalized to theReturn a regular expression to ...form. Kept the verbdetectrather thanmatchto preserve the existing semantic distinction the original description drew.@stdlib/regexp/semverThe
descriptionfield readRegular expression to match a semantic version string., out of step with the function's JSDoc (Returns a regular expression to match a semantic version string.) and with the namespace convention (24/27 = 88.9%). Normalized to theReturn a regular expression to ...form.Related Issues
None.
Questions
No.
Other
Validation
package.jsonkeys,keywords, README headings,manifest.jsonshape, and test/benchmark/example filenames.@param,@returns,@throws,@example), error-construction style, validation prologue, andrequire-based dependencies.descriptionprefix). The correction was confirmed mechanical, non-behavioral, and supported by both the per-package JSDoc and the namespace majority. References to the existing description strings outsidepackage.jsonwere checked (docs/types/index.d.ts,docs/repl.txt,lib/index.jsmodule JSDoc) — none rely on the old prefix.## See AlsoREADME sections in 5 packages (generator-owned per the gate); the missingtest/test.main.jsinreviverandto-json(lib/index.jsis a pure re-export oflib/main.js, so the file would duplicatetest/test.js); the absentregexkeyword inreviverandto-json(those packages follow the utility-package keyword template, not the regex-producer template); and theErrorvsTypeErrorchoice for the[platform]/[mode]argument across 5 packages (variance below the 75% majority threshold and observable behavior).Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This pull request was authored by Claude Code via an automated cross-package drift-detection routine that extracts structural and semantic features from every package in a randomly selected stdlib namespace, identifies the majority pattern per feature, and proposes corrections to outliers. Findings were filtered with a 75% majority threshold and reviewed against materiality and intentional-deviation gates before being applied. A human maintainer should promote this from draft after independent review.
@stdlib-js/reviewers
Generated by Claude Code