Add TOML examples to --config help text#25013
Conversation
|
ntBre
left a comment
There was a problem hiding this comment.
Thanks, this looks reasonable to me overall, I just had one nit about a newline. Would you mind updating your test plan to include screenshots of the CLI help output and the generated documentation?
I'm also curious about this part of the summary:
This is a follow-up to improvements in how configuration overrides are handled.
Which PR is this a follow-up to?
Maybe I'm off base here, but this seems like the kind of mistake that an LLM could make. Please make sure to follow our AI Policy.
| /// Overrides of individual settings using this option always take precedence | ||
| /// over all configuration files, including configuration files that were also | ||
| /// specified using `--config`. | ||
|
|
There was a problem hiding this comment.
Do we need this blank line?
There was a problem hiding this comment.
Do we need this blank line?
Thanks for that. I have removed it.
I also checked the CLI help and generated docs:
cargo dev generate-cli-helptarget/debug/ruff --helpsed -n '548,566p' docs/configuration.mdgit diff --exit-code
The help output and generated docs both show the new --config examples, and git diff --exit-code shows no extra changes after regenerating the docs.
--config help text


This PR adds TOML examples to the
--confighelp text to clarify that it accepts both file paths and inline key-value pairs.