Skip to content

[ty] Remove brackets around option names #18037

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MichaReiser merged 1 commit into from
May 12, 2025
Merged

[ty] Remove brackets around option names #18037

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/ruff_dev/src/generate_ty_options.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ impl Set {
fn emit_field(output: &mut String, name: &str, field: &OptionField, parents: &[Set]) {
let header_level = if parents.is_empty() { "###" } else { "####" };

let _ = writeln!(output, "{header_level} [`{name}`]");
let _ = writeln!(output, "{header_level} `{name}`");

output.push('\n');

if let Some(deprecated) = &field.deprecated {
output.push_str("!!! warning \"Deprecated\"\n");
output.push_str(" This option has been deprecated");
output.push_str("> [!WARN] \"Deprecated\"\n");
output.push_str("> This option has been deprecated");

if let Some(since) = deprecated.since {
write!(output, " in {since}").unwrap();
Expand Down
20 changes: 10 additions & 10 deletions crates/ty/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Configuration
#### [`respect-ignore-files`]
#### `respect-ignore-files`

Whether to automatically exclude files that are ignored by `.ignore`,
`.gitignore`, `.git/info/exclude`, and global `gitignore` files.
Expand All @@ -18,7 +18,7 @@ respect-ignore-files = false

---

#### [`rules`]
#### `rules`

Configures the enabled rules and their severity.

Expand Down Expand Up @@ -47,7 +47,7 @@ division-by-zero = "ignore"

## `environment`

#### [`extra-paths`]
#### `extra-paths`

List of user-provided paths that should take first priority in the module resolution.
Examples in other type checkers are mypy's `MYPYPATH` environment variable,
Expand All @@ -66,7 +66,7 @@ extra-paths = ["~/shared/my-search-path"]

---

#### [`python`]
#### `python`

Path to the Python installation from which ty resolves type information and third-party dependencies.

Expand All @@ -88,7 +88,7 @@ python = "./.venv"

---

#### [`python-platform`]
#### `python-platform`

Specifies the target platform that will be used to analyze the source code.
If specified, ty will understand conditions based on comparisons with `sys.platform`, such
Expand All @@ -115,7 +115,7 @@ python-platform = "win32"

---

#### [`python-version`]
#### `python-version`

Specifies the version of Python that will be used to analyze the source code.
The version should be specified as a string in the format `M.m` where `M` is the major version
Expand All @@ -139,7 +139,7 @@ python-version = "3.12"

---

#### [`typeshed`]
#### `typeshed`

Optional path to a "typeshed" directory on disk for us to use for standard-library types.
If this is not provided, we will fallback to our vendored typeshed stubs for the stdlib,
Expand All @@ -160,7 +160,7 @@ typeshed = "/path/to/custom/typeshed"

## `src`

#### [`root`]
#### `root`

The root(s) of the project, used for finding first-party modules.

Expand All @@ -179,7 +179,7 @@ root = ["./app"]

## `terminal`

#### [`error-on-warning`]
#### `error-on-warning`

Use exit code 1 if there are any warning-level diagnostics.

Expand All @@ -199,7 +199,7 @@ error-on-warning = true

---

#### [`output-format`]
#### `output-format`

The format to use for printing diagnostic messages.

Expand Down
Loading