Back to all reviewers

Document configuration defaults clearly

google-gemini/gemini-cli
Based on 3 comments
Markdown

When documenting configuration options, always specify exact file paths, explicit default values, and clarify potentially confusing settings to prevent user confusion. This includes documenting where settings are persisted, what happens when optional properties are omitted, and explaining any non-obvious behavior like token budget comparisons.

Configurations Markdown

Reviewer Prompt

When documenting configuration options, always specify exact file paths, explicit default values, and clarify potentially confusing settings to prevent user confusion. This includes documenting where settings are persisted, what happens when optional properties are omitted, and explaining any non-obvious behavior like token budget comparisons.

For example, instead of just mentioning “settings are saved,” specify the exact location:

// Settings are saved to ~/.gemini/settings.json
"vim": true

When documenting optional configuration properties, explicitly state the default behavior:

// authProviderType is optional - omitting it defaults to "dynamic_discovery"
"authProviderType": "dynamic_discovery"  // default

For complex configurations that might cause confusion, add clarifying comments:

// tokenBudget is compared against character length as an approximation
"summarizeToolOutput": {
  "run_shell_command": {
    "tokenBudget": 100  // approximate token count, compared to character length
  }
}
3
Comments Analyzed
Markdown
Primary Language
Configurations
Category

Source Discussions