docs: clarify configure show command help#928
Conversation
Update the configure show command description to explain that it displays the effective runtime configuration stored for one model or all models.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Switching
json.MarshalIndentfrom a two-space indent (" ") to a single space (" ") will change the JSON output format; confirm this is intentional and, if so, align any other related commands for consistency.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Switching `json.MarshalIndent` from a two-space indent (`" "`) to a single space (`" "`) will change the JSON output format; confirm this is intentional and, if so, align any other related commands for consistency.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the show command's descriptions and formatting in the CLI. A review comment identifies an accidental reduction in JSON indentation from two spaces to one, which reduces output readability, and suggests reverting it to maintain consistency and user empathy.
| } | ||
| jsonResult, err := json.MarshalIndent(configs, "", " ") | ||
|
|
||
| jsonResult, err := json.MarshalIndent(configs, "", " ") |
There was a problem hiding this comment.
The JSON indentation has been reduced from two spaces to one space. This makes the command output harder to read and appears to be an accidental change as it is not mentioned in the PR description. Reverting to two spaces ensures the output remains user-friendly and consistent with standard formatting.
| jsonResult, err := json.MarshalIndent(configs, "", " ") | |
| jsonResult, err := json.MarshalIndent(configs, "", " ") |
References
- User empathy — How does this affect the people who use, operate, and maintain this system? Consider developer ergonomics, operational burden, error messages, failure modes, and the debugging experience. (link)
|
@Montana is the bot comment worth addressing |
…e current output format.
Hey @ericcurtin, I've addressed it. I appreciate it @ericcurtin. |
2 participants
Update the configure show command description to explain that it displays the effective runtime configuration stored for one model or all models.