Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[ty] Clarify `ty check` output default in documentation. (#18246) 

Co-authored-by: Micha Reiser <micha@reiser.io>
This commit is contained in:
Sumana Harihareswara 2025-05-22 13:24:58 +00:00 committed by GitHub
parent 6df10c638e
commit 029085fa72
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/ty/docs/cli.md generated
View File

@ -51,7 +51,7 @@ ty check [OPTIONS] [PATH]...
</dd><dt id="ty-check--output-format"><a href="#ty-check--output-format"><code>--output-format</code></a> <i>output-format</i></dt><dd><p>The format to use for printing diagnostic messages</p> </dd><dt id="ty-check--output-format"><a href="#ty-check--output-format"><code>--output-format</code></a> <i>output-format</i></dt><dd><p>The format to use for printing diagnostic messages</p>
<p>Possible values:</p> <p>Possible values:</p>
<ul> <ul>
<li><code>full</code>: Print diagnostics verbosely, with context and helpful hints</li> <li><code>full</code>: Print diagnostics verbosely, with context and helpful hints [default]</li>
<li><code>concise</code>: Print diagnostics concisely, one per line</li> <li><code>concise</code>: Print diagnostics concisely, one per line</li>
</ul></dd><dt id="ty-check--project"><a href="#ty-check--project"><code>--project</code></a> <i>project</i></dt><dd><p>Run the command within the given project directory.</p> </ul></dd><dt id="ty-check--project"><a href="#ty-check--project"><code>--project</code></a> <i>project</i></dt><dd><p>Run the command within the given project directory.</p>
<p>All <code>pyproject.toml</code> files will be discovered by walking up the directory tree from the given project directory, as will the project's virtual environment (<code>.venv</code>) unless the <code>venv-path</code> option is set.</p> <p>All <code>pyproject.toml</code> files will be discovered by walking up the directory tree from the given project directory, as will the project's virtual environment (<code>.venv</code>) unless the <code>venv-path</code> option is set.</p>

2
crates/ty/src/args.rs
View File

@ -283,7 +283,7 @@ impl clap::Args for RulesArg {
/// The diagnostic output format. /// The diagnostic output format.
#[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)] #[derive(Copy, Clone, Hash, Debug, PartialEq, Eq, PartialOrd, Ord, Default, clap::ValueEnum)]
pub enum OutputFormat { 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 /// Diagnostic messages may include additional context and
/// annotations on the input to help understand the message. /// annotations on the input to help understand the message.