Back to all reviewers

Remove unnecessary elements

argoproj/argo-cd
Based on 2 comments
Markdown

Eliminate superfluous syntax and words that don't add value to improve code readability and maintain consistent style. This includes removing unnecessary quotes in YAML files and avoiding redundant words in documentation.

Code Style Markdown

Reviewer Prompt

Eliminate superfluous syntax and words that don’t add value to improve code readability and maintain consistent style. This includes removing unnecessary quotes in YAML files and avoiding redundant words in documentation.

For YAML files, avoid unnecessary quotes around simple string values. When quotes are required (e.g., for strings with special characters), prefer single quotes over double quotes:

# Good
type: git
url: https://example.com
name: 'special-name-with-hyphens'

# Avoid
type: "git"
url: "https://example.com"

In documentation and comments, remove redundant words that don’t contribute to clarity:

# Good
Finally, after the Linter reports no errors, run git status

# Avoid
Finally, after the Linter reports no errors anymore, run git status

This practice reduces visual clutter, improves readability, and maintains consistent formatting standards across the codebase.

2
Comments Analyzed
Markdown
Primary Language
Code Style
Category

Source Discussions