Automattic / Automattic/harper

[Bug] False positive: SentenceCapitalization flags text after comma in JSDocs/Markdown

Open Beginner friendly
#3,961 3 comments 1 reaction 0 assignees View on GitHub
bug false-positive harper-core linting markdown
Dominant language
Rust
Stars
15.4k
Forks
627
Avg merge
1d 15h
Merged PRs (30d)
106

Description

**What got flagged?**
```
Writes Zep's statistical information to the console, including invocations, executions, saved call percentage, active/peak burst metrics, and cancellation/abort counts.
```

**Why is this incorrect?**
The rule should recognize that the token following a mid-sentence comma (`'console, including'`) is a continuation of the same sentence structure and should not require capitalization.

**Example of correct usage:**
Writes Zep's statistical information to the console, including invocations, executions, saved call percentage, active/peak burst metrics, and cancellation/abort counts.

Contributor guide

Open the contributing guide

Research direction

Start by locating the SentenceCapitalization rule and reproducing the supplied JSDoc/Markdown example. Done means text following a mid-sentence comma is not flagged while the rule's existing capitalization behavior remains covered by its tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.