diff --git a/crates/ruff/src/args.rs b/crates/ruff/src/args.rs index 2e4817836e..160d6a19b8 100644 --- a/crates/ruff/src/args.rs +++ b/crates/ruff/src/args.rs @@ -538,8 +538,11 @@ pub struct FormatCommand { #[arg(long, help_heading = "Miscellaneous", alias = "exit-non-zero-on-fix")] pub exit_non_zero_on_format: bool, - /// Output serialization format for violations. + /// Output serialization format for violations, when used with `--check`. /// The default serialization format is "full". + /// + /// Note that this option is currently only respected in preview mode. A warning will be emitted + /// if this flag is used on stable. #[arg(long, value_enum, env = "RUFF_OUTPUT_FORMAT")] pub output_format: Option, } diff --git a/docs/configuration.md b/docs/configuration.md index 13aee26da9..8d3297fbca 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -728,10 +728,10 @@ Options: Enable preview mode; enables unstable formatting. Use `--no-preview` to disable --output-format - Output serialization format for violations. The default serialization - format is "full" [env: RUFF_OUTPUT_FORMAT=] [possible values: - concise, full, json, json-lines, junit, grouped, github, gitlab, - pylint, rdjson, azure, sarif] + Output serialization format for violations, when used with `--check`. + The default serialization format is "full" [env: RUFF_OUTPUT_FORMAT=] + [possible values: concise, full, json, json-lines, junit, grouped, + github, gitlab, pylint, rdjson, azure, sarif] -h, --help Print help (see more with '--help')