From 029085fa7239eb25f9b60b6aff56aa54945becaf Mon Sep 17 00:00:00 2001 From: Sumana Harihareswara Date: Thu, 22 May 2025 13:24:58 +0000 Subject: [PATCH] [ty] Clarify `ty check` output default in documentation. (#18246) Co-authored-by: Micha Reiser --- crates/ty/docs/cli.md | 2 +- crates/ty/src/args.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/ty/docs/cli.md b/crates/ty/docs/cli.md index 61d2e392f7..d5cfaa311b 100644 --- a/crates/ty/docs/cli.md +++ b/crates/ty/docs/cli.md @@ -51,7 +51,7 @@ ty check [OPTIONS] [PATH]...
--output-format output-format

The format to use for printing diagnostic messages

Possible values:

    -
  • full: Print diagnostics verbosely, with context and helpful hints
  • +
  • full: Print diagnostics verbosely, with context and helpful hints [default]
  • concise: Print diagnostics concisely, one per line
--project project

Run the command within the given project directory.

All pyproject.toml files will be discovered by walking up the directory tree from the given project directory, as will the project's virtual environment (.venv) unless the venv-path option is set.

diff --git a/crates/ty/src/args.rs b/crates/ty/src/args.rs index 9321319fad..e5034cfdf9 100644 --- a/crates/ty/src/args.rs +++ b/crates/ty/src/args.rs @@ -283,7 +283,7 @@ impl clap::Args for RulesArg { /// The diagnostic output format. #[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] pub enum OutputFormat { - /// Print diagnostics verbosely, with context and helpful hints. + /// Print diagnostics verbosely, with context and helpful hints \[default\]. /// /// Diagnostic messages may include additional context and /// annotations on the input to help understand the message.