First Person Pronoun Check

This rule helps maintain a professional and objective tone in documentation by flagging the use of first-person pronouns. Technical documentation and professional writing often benefits from a more neutral, third-person perspective that focuses on the subject matter rather than the writer.

The rule checks for common first-person pronouns and their variants, helping writers maintain consistency with style guides like Google's Developer Documentation Style Guide, which recommends avoiding personal pronouns in technical writing.

Examples:

✗ Incorrect:

  • "I recommend using this function"
  • "Let me show you how it works"
  • "In my experience, this works better"
  • "This code is mine"
  • "I'm going to demonstrate"

✓ Better alternatives:

  • "This function is recommended"
  • "This example demonstrates"
  • "Testing shows this works better"
  • "This code belongs to the project"
  • "This demonstration shows"

The rule will flag any usage of: "I", "I'm", "me", "my", or "mine", regardless of capitalization.

Rule Source

This rule comes from: https://github.com/jump-dev/JuMP.jl

Rule Definition

extends: existence
message: "Avoid first-person pronouns such as '%s'."
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
ignorecase: true
level: warning
nonword: true
tokens:
  - (?:^|\s)I\s
  - (?:^|\s)I,\s
  - \bI'm\b
  - \bme\b
  - \bmy\b
  - \bmine\b