Skip to content

commented-out-config

unexplained disabled config blocks or adjacent alternatives

Why

Disabled configuration becomes stale while version control already preserves its history.

Fix

Delete inactive settings, or explain the supported default, optional override, or constraint.

Examples

Before — flagged An unexplained alternative repeats the adjacent active key
config.toml
# timeout = 30
timeout = 10
After — preferred A labeled optional override remains documentation
config.toml
# Optional local override:
# timeout = 30
timeout = 10

Files

**/*.{yaml,yml,toml,jsonc}