docs: add missing trailing periods in README descriptions#11751
Merged
docs: add missing trailing periods in README descriptions#11751
Conversation
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Planeshifter
commented
Apr 25, 2026
Codebase-wide scan of all 5,485 stdlib package READMEs for blockquote taglines and h4-description sentences missing a trailing period. Applies the period to the five clean-drift cases: - `constants/complex128`: tagline (line 23) and h4 description (line 35). - `repl/presentation`: `Presentation.prototype.show()` description (the only such method whose description omitted the period; all sibling prototype-method descriptions in the same file end with a period). - `stats/base/dists/bernoulli/cdf`: `cdf.factory( p )` description. - `stats/base/dists/geometric/cdf`: `cdf.factory( p )` description. - `stats/base/dists/geometric/logcdf`: `logcdf.factory( p )` description. Other scan hits (`TODO` placeholders, mid-sentence lines that continue into a following code block or table) are intentional and left untouched.
ec4837c to
ac94576
Compare
constants namespace with majority patterns
kgryte
approved these changes
Apr 25, 2026
Member
|
As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge. |
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
Codebase-wide scan for README descriptions missing a trailing period; applies the period in the five clean-drift cases.
The scan walked all 5,485 stdlib package READMEs and checked two patterns:
#### …h4 header.Both patterns are stylistically expected to terminate in
./!/?/:and the convention is consistently followed across the codebase. The scan returned exactly one tagline outlier and 23 h4-description outliers; 18 of the 23 are intentional and were not touched (TODOplaceholders in shared/scaffold READMEs, and lines that continue mid-sentence into a following code block or table). The remaining 5 are clean drift and are fixed in this PR.Files touched
constants/complex128/README.md— tagline (line 23) and#### constantsh4 description (line 35).repl/presentation/README.md—Presentation.prototype.show()description (line 915). Every other prototype-method description in the same file ends with a period.stats/base/dists/bernoulli/cdf/README.md—cdf.factory( p )description (line 90). All sibling distributionfactorydescriptions (normal,binomial,poisson,exponential,uniform, …) end with a period.stats/base/dists/geometric/cdf/README.md—cdf.factory( p )description (line 90).stats/base/dists/geometric/logcdf/README.md—logcdf.factory( p )description (line 90).Related Issues
None.
Questions
No.
Other
Scan methodology
For each README in
lib/node_modules/@stdlib/:# …H1 heading (skipping HTML comments / license blocks); read forward up to 8 lines for the first> …blockquote; flag if its trimmed text doesn't end in./!/?/:.#### …h4 heading, look at the next non-blank line; if it begins with plain prose (not a code fence, list bullet, blockquote, table, HTML, or markdown link/image), flag if it doesn't end in punctuation.After applying the 5 fixes, the tagline check returns 0 findings and the h4 check returns 18 findings, every one of which is either a deliberate
TODOor a multi-paragraph description whose first paragraph ends with a comma/clause continuation.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code. Initial scope was a drift-detection routine over the
@stdlib/constantsnamespace; per @Planeshifter's review, the scope was narrowed to README trailing-period drift only and broadened to a codebase-wide scan, with the rename / test-description findings dropped. All five corrections are mechanical single-character additions.