Skip to content

docs: add missing trailing periods in README descriptions#11751

Merged
kgryte merged 1 commit intodevelopfrom
claude/compassionate-ritchie-2VHRa
Apr 25, 2026
Merged

docs: add missing trailing periods in README descriptions#11751
kgryte merged 1 commit intodevelopfrom
claude/compassionate-ritchie-2VHRa

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented Apr 24, 2026

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:

  1. The blockquote tagline immediately following the package's first H1 heading.
  2. The plain-text description on the line directly following a #### … 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 (TODO placeholders 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 #### constants h4 description (line 35).
  • repl/presentation/README.mdPresentation.prototype.show() description (line 915). Every other prototype-method description in the same file ends with a period.
  • stats/base/dists/bernoulli/cdf/README.mdcdf.factory( p ) description (line 90). All sibling distribution factory descriptions (normal, binomial, poisson, exponential, uniform, …) end with a period.
  • stats/base/dists/geometric/cdf/README.mdcdf.factory( p ) description (line 90).
  • stats/base/dists/geometric/logcdf/README.mdlogcdf.factory( p ) description (line 90).

Related Issues

None.

Questions

No.

Other

Scan methodology

For each README in lib/node_modules/@stdlib/:

  • Tagline check: locate the first # … 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 check: for each #### … 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 TODO or a multi-paragraph description whose first paragraph ends with a comma/clause continuation.

Checklist

AI Assistance

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

This PR was authored by Claude Code. Initial scope was a drift-detection routine over the @stdlib/constants namespace; 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.


@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
constants/array $\color{green}160/160$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}160/160$
$\color{green}+100.00%$
constants/complex128 $\color{green}219/219$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}219/219$
$\color{green}+100.00%$
constants/complex64 $\color{green}219/219$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}219/219$
$\color{green}+100.00%$
constants/path $\color{red}412/414$
$\color{green}+99.52%$
$\color{red}7/9$
$\color{green}+77.78%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{red}412/414$
$\color{green}+99.52%$
constants/unicode $\color{green}156/156$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}156/156$
$\color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

Comment thread lib/node_modules/@stdlib/constants/complex128/README.md
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.
@Planeshifter Planeshifter force-pushed the claude/compassionate-ritchie-2VHRa branch from ec4837c to ac94576 Compare April 25, 2026 23:18
@Planeshifter Planeshifter changed the title style: align outliers in constants namespace with majority patterns docs: add missing trailing periods in README descriptions Apr 25, 2026
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 25, 2026
@kgryte kgryte marked this pull request as ready for review April 25, 2026 23:24
@kgryte kgryte requested a review from a team April 25, 2026 23:24
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 25, 2026
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 25, 2026
@kgryte
Copy link
Copy Markdown
Member

kgryte commented Apr 25, 2026

As the CI failure is not due to changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte merged commit cc0ab62 into develop Apr 25, 2026
52 of 53 checks passed
@kgryte kgryte deleted the claude/compassionate-ritchie-2VHRa branch April 25, 2026 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants