Automattic / Automattic/harper

Identifiers should be nouns

Open
#242 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Rust
Stars
15.4k
Forks
627
Avg merge
1d 15h
Merged PRs (30d)
106

Description

When we refer to an identifier in a comment followed by a linking verb, Harper throws a false-positive because it does not mark the identifier as being a noun.

The `is` is marked as improper here:

```java
/** The user the JWT is associated with. */
String usr;
```

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the JavaDoc example in the issue and tracing how Harper classifies identifiers in comments before a linking verb. Done means the `is` in that example is no longer reported as improper, with existing grammar checks still behaving as expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.