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

Use environment.root instead of src.root in README (#694)
Some checks are pending
CI / python package (push) Waiting to run
Details
CI / pre-commit (push) Waiting to run
Details
CI / Check generated files unedited (push) Waiting to run
Details

Browse source
This commit is contained in:
Micha Reiser 2025-06-24 14:53:00 +02:00 • committed by GitHub
parent 5f2a43e7e5
commit 4bd25b710b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/README.md
View file

@ -76,7 +76,7 @@ By default, ty searches for first-party modules in the project's root directory
directory, if present.
If your project uses a different layout, configure the project's
[`src.root`](./reference/configuration.md#root) in your `pyproject.toml` or `ty.toml`. For example,
[`environment.root`](./reference/configuration.md#root) in your `pyproject.toml` or `ty.toml`. For example,
if your project's code is in an `app/` directory:
```text
@ -88,11 +88,11 @@ example-pkg
└── __init__.py
```
then set [`src.root`](./reference/configuration.md#root) in your `pyproject.toml` to `./app`:
then set [`environment.root`](./reference/configuration.md#root) in your `pyproject.toml` to `["./app"]`:
```toml
[tool.ty.src]
root = "./app"
[tool.ty.environment]
root = ["./app"]
```
### Third-party modules