From ca2224862882e73d40ebfe8fe3f99312b013a3e9 Mon Sep 17 00:00:00 2001 From: Sashko <20253875+sashko1988@users.noreply.github.com> Date: Fri, 19 Jul 2024 19:51:46 +0200 Subject: [PATCH] Update docs Settings output-format default (#12409) ## Update docs Settings output-format default Fixes https://github.com/astral-sh/ruff/issues/12350 ## Test Plan Run all automation mentioned here https://github.com/astral-sh/ruff/blob/fe04f2b09d0b676f1fa09f732e907ef64deffbb1/CONTRIBUTING.md#development Manually verified changes in the generated MkDocs site. Co-authored-by: Oleksandr Zavertniev --- crates/ruff_workspace/src/options.rs | 6 +++--- ruff.schema.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/ruff_workspace/src/options.rs b/crates/ruff_workspace/src/options.rs index caaf0e5dac2f9..c8eb6ad248c9a 100644 --- a/crates/ruff_workspace/src/options.rs +++ b/crates/ruff_workspace/src/options.rs @@ -74,13 +74,13 @@ pub struct Options { )] pub extend: Option, - /// The style in which violation messages should be formatted: `"full"` - /// (shows source), `"concise"` (default), `"grouped"` (group messages by file), `"json"` + /// The style in which violation messages should be formatted: `"full"` (default) + /// (shows source), `"concise"`, `"grouped"` (group messages by file), `"json"` /// (machine-readable), `"junit"` (machine-readable XML), `"github"` (GitHub /// Actions annotations), `"gitlab"` (GitLab CI code quality report), /// `"pylint"` (Pylint text format) or `"azure"` (Azure Pipeline logging commands). #[option( - default = r#""concise""#, + default = r#""full""#, value_type = r#""full" | "concise" | "grouped" | "json" | "junit" | "github" | "gitlab" | "pylint" | "azure""#, example = r#" # Group violations by containing file. diff --git a/ruff.schema.json b/ruff.schema.json index 2114f20e64318..02fd6a5e4d5de 100644 --- a/ruff.schema.json +++ b/ruff.schema.json @@ -531,7 +531,7 @@ } }, "output-format": { - "description": "The style in which violation messages should be formatted: `\"full\"` (shows source), `\"concise\"` (default), `\"grouped\"` (group messages by file), `\"json\"` (machine-readable), `\"junit\"` (machine-readable XML), `\"github\"` (GitHub Actions annotations), `\"gitlab\"` (GitLab CI code quality report), `\"pylint\"` (Pylint text format) or `\"azure\"` (Azure Pipeline logging commands).", + "description": "The style in which violation messages should be formatted: `\"full\"` (default) (shows source), `\"concise\"`, `\"grouped\"` (group messages by file), `\"json\"` (machine-readable), `\"junit\"` (machine-readable XML), `\"github\"` (GitHub Actions annotations), `\"gitlab\"` (GitLab CI code quality report), `\"pylint\"` (Pylint text format) or `\"azure\"` (Azure Pipeline logging commands).", "anyOf": [ { "$ref": "#/definitions/OutputFormat"