point out preview restriction on format --output-format

This commit is contained in:
Brent Westbrook 2025-09-26 14:05:45 -04:00
parent 2ce8f80877
commit 007a22f1c0
2 changed files with 8 additions and 5 deletions

View file

@ -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<OutputFormat>,
}