mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-07-07 21:25:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix header levels in generated settings reference (#19089)

Browse source 
The headers were one level too deep for child items, and the top-level
`rules` header was way off.
This commit is contained in:
Zanie Blue 2025-07-02 09:01:23 -05:00 • committed by GitHub
parent e599c9d0d3
commit 522fd4462e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 18 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

3
crates/ruff_dev/src/generate_ty_options.rs
View file

@ -114,6 +114,7 @@ fn generate_set(output: &mut String, set: Set, parents: &mut Vec<Set>) {
parents.pop();
}
#[derive(Debug)]
enum Set {
Toplevel(OptionSet),
Named { name: String, set: OptionSet },
@ -136,7 +137,7 @@ impl Set {
}
fn emit_field(output: &mut String, name: &str, field: &OptionField, parents: &[Set]) {
let header_level = if parents.is_empty() { "###" } else { "####" };
let header_level = "#".repeat(parents.len() + 1);
let _ = writeln!(output, "{header_level} `{name}`");

32
crates/ty/docs/configuration.md generated
View file

@ -1,7 +1,7 @@
<!-- WARNING: This file is auto-generated (cargo dev generate-all). Update the doc comments on the 'Options' struct in 'crates/ty_project/src/metadata/options.rs' if you want to change anything here. -->
# Configuration
#### `rules`
## `rules`
Configures the enabled rules and their severity.
@ -30,7 +30,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,
@ -49,7 +49,7 @@ extra-paths = ["~/shared/my-search-path"]
---
#### `python`
### `python`
Path to the Python installation from which ty resolves type information and third-party dependencies.
@ -71,7 +71,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
@ -99,7 +99,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
@ -132,7 +132,7 @@ python-version = "3.12"
---
#### `root`
### `root`
The root paths of the project, used for finding first-party modules.
@ -161,7 +161,7 @@ root = ["./src", "./lib", "./vendor"]
---
#### `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,
@ -213,7 +213,7 @@ possibly-unresolved-reference = "ignore"
```
#### `exclude`
### `exclude`
A list of file and directory patterns to exclude from this override.
@ -240,7 +240,7 @@ exclude = [
---
#### `include`
### `include`
A list of file and directory patterns to include for this override.
@ -266,7 +266,7 @@ include = [
---
#### `rules`
### `rules`
Rule overrides for files matching the include/exclude patterns.
@ -292,7 +292,7 @@ possibly-unresolved-reference = "ignore"
## `src`
#### `exclude`
### `exclude`
A list of file and directory patterns to exclude from type checking.
@ -357,7 +357,7 @@ exclude = [
---
#### `include`
### `include`
A list of files and directories to check. The `include` option
follows a similar syntax to `.gitignore` but reversed:
@ -396,7 +396,7 @@ include = [
---
#### `respect-ignore-files`
### `respect-ignore-files`
Whether to automatically exclude files that are ignored by `.ignore`,
`.gitignore`, `.git/info/exclude`, and global `gitignore` files.
@ -415,7 +415,7 @@ respect-ignore-files = false
---
#### `root`
### `root`
> [!WARN] "Deprecated"
> This option has been deprecated. Use `environment.root` instead.
@ -446,7 +446,7 @@ root = "./app"
## `terminal`
#### `error-on-warning`
### `error-on-warning`
Use exit code 1 if there are any warning-level diagnostics.
@ -466,7 +466,7 @@ error-on-warning = true
---
#### `output-format`
### `output-format`
The format to use for printing diagnostic messages.