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

[ty] Fix incorrect type of src.root in documentation (#18040)

Browse source
This commit is contained in:
Micha Reiser 2025-05-12 14:28:14 +02:00 • committed by GitHub
parent fcd858e0c8
commit be6ec613db
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
crates/ty/docs/configuration.md
View file

@ -162,17 +162,17 @@ typeshed = "/path/to/custom/typeshed"
#### `root`
The root(s) of the project, used for finding first-party modules.
The root of the project, used for finding first-party modules.
**Default value**: `[".", "./src"]`
**Type**: `list[str]`
**Type**: `str`
**Example usage** (`pyproject.toml`):
```toml
[tool.ty.src]
root = ["./app"]
root = "./app"
```
---

6
crates/ty_project/src/metadata/options.rs
View file

@ -352,13 +352,13 @@ pub struct EnvironmentOptions {
#[serde(rename_all = "kebab-case", deny_unknown_fields)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct SrcOptions {
/// The root(s) of the project, used for finding first-party modules.
/// The root of the project, used for finding first-party modules.
#[serde(skip_serializing_if = "Option::is_none")]
#[option(
default = r#"[".", "./src"]"#,
value_type = "list[str]",
value_type = "str",
example = r#"
root = ["./app"]
root = "./app"
"#
)]
pub root: Option<RelativePathBuf>,

2
ty.schema.json
View file

@ -839,7 +839,7 @@
"type": "object",
"properties": {
"root": {
"description": "The root(s) of the project, used for finding first-party modules.",
"description": "The root of the project, used for finding first-party modules.",
"type": [
"string",
"null"