Skip to content

Add TOML examples to --config help text #25013

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ntBre merged 3 commits into from
May 12, 2026
+17 −10
Merged

Add TOML examples to --config help text #25013

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c8d752
docs(cli): add TOML examples to --config help text
darestack May 6, 2026
e909cec
docs: regenerate configuration documentation
darestack May 6, 2026
024ba53
docs: remove extra blank line in config help
darestack May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion crates/ruff/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ pub struct GlobalConfigArgs {
/// Either a path to a TOML configuration file (`pyproject.toml` or `ruff.toml`),
/// or a TOML `<KEY> = <VALUE>` pair
/// (such as you might find in a `ruff.toml` configuration file)
/// overriding a specific configuration option.
/// overriding a specific configuration option
/// (e.g., `--config "lint.line-length = 100"` or `--config "format.quote-style = 'single'"`).
/// Overrides of individual settings using this option always take precedence
/// over all configuration files, including configuration files that were also
/// specified using `--config`.

Copy link
Copy Markdown
Contributor

@ntBre ntBre May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this blank line?

Suggested change

Copy link
Copy Markdown
Contributor Author

@darestack darestack May 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-help
  • target/debug/ruff --help
  • sed -n '548,566p' docs/configuration.md
  • git 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.

Evidence:
Screenshot from 2026-05-09 09-55-17
Screenshot from 2026-05-09 09-55-34

#[arg(
long,
action = clap::ArgAction::Append,
Expand Down
24 changes: 15 additions & 9 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,9 +554,11 @@ Global options:
Either a path to a TOML configuration file (`pyproject.toml` or
`ruff.toml`), or a TOML `<KEY> = <VALUE>` pair (such as you might
find in a `ruff.toml` configuration file) overriding a specific
configuration option. Overrides of individual settings using this
option always take precedence over all configuration files, including
configuration files that were also specified using `--config`
configuration option (e.g., `--config "lint.line-length = 100"` or
`--config "format.quote-style = 'single'"`). Overrides of individual
settings using this option always take precedence over all
configuration files, including configuration files that were also
specified using `--config`
--isolated
Ignore all configuration files
--color <WHEN>
Expand Down Expand Up @@ -695,9 +697,11 @@ Global options:
Either a path to a TOML configuration file (`pyproject.toml` or
`ruff.toml`), or a TOML `<KEY> = <VALUE>` pair (such as you might
find in a `ruff.toml` configuration file) overriding a specific
configuration option. Overrides of individual settings using this
option always take precedence over all configuration files, including
configuration files that were also specified using `--config`
configuration option (e.g., `--config "lint.line-length = 100"` or
`--config "format.quote-style = 'single'"`). Overrides of individual
settings using this option always take precedence over all
configuration files, including configuration files that were also
specified using `--config`
--isolated
Ignore all configuration files
--color <WHEN>
Expand Down Expand Up @@ -789,9 +793,11 @@ Global options:
Either a path to a TOML configuration file (`pyproject.toml` or
`ruff.toml`), or a TOML `<KEY> = <VALUE>` pair (such as you might
find in a `ruff.toml` configuration file) overriding a specific
configuration option. Overrides of individual settings using this
option always take precedence over all configuration files, including
configuration files that were also specified using `--config`
configuration option (e.g., `--config "lint.line-length = 100"` or
`--config "format.quote-style = 'single'"`). Overrides of individual
settings using this option always take precedence over all
configuration files, including configuration files that were also
specified using `--config`
--isolated
Ignore all configuration files
--color <WHEN>
Expand Down
Loading