From ef4d00a94d1c7380e8cd3c0b0ba9068a1c7a429c Mon Sep 17 00:00:00 2001 From: Aria Desires Date: Fri, 12 Dec 2025 13:17:21 -0500 Subject: [PATCH 1/3] update implicit root docs --- docs/modules.md | 4 ++-- docs/reference/configuration.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/modules.md b/docs/modules.md index 6296d4b12e..4b95077ff7 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -27,8 +27,8 @@ then set [`environment.root`](./reference/configuration.md#root) in your `pyproj root = ["./app"] ``` -Note that `python` and `tests` folders are automatically added to the project `root` if they exist, -and if they are not packages themselves (i.e. they do not contain an `__init__.py` file or an +Note a `./python` folder is automatically added to the project `root` if it exists, +and is not itself a package (i.e. does not contain an `__init__.py` file or an `__init__.pyi` file). ## Third-party modules diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 4ecf8f8399..0768f1b26a 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -158,7 +158,7 @@ If left unspecified, ty will try to detect common project layouts and initialize * if a `.//` directory exists, include `.` and `./` in the first party search path * otherwise, default to `.` (flat layout) -Besides, if a `./python` or `./tests` directory exists and is not a package (i.e. it does not contain an `__init__.py` or `__init__.pyi` file), +Additionally, if a `./python` directory exists and is not a package (i.e. it does not contain an `__init__.py` or `__init__.pyi` file), it will also be included in the first party search path. **Default value**: `null` @@ -443,7 +443,7 @@ If left unspecified, ty will try to detect common project layouts and initialize * if a `.//` directory exists, include `.` and `./` in the first party search path * otherwise, default to `.` (flat layout) -Besides, if a `./tests` directory exists and is not a package (i.e. it does not contain an `__init__.py` file), +Additionally, if a `./python` directory exists and is not a package (i.e. it does not contain an `__init__.py` file), it will also be included in the first party search path. **Default value**: `null` From 64b6dbdfa1e560996e60034b3bfe90abc6acbfff Mon Sep 17 00:00:00 2001 From: Aria Desires Date: Fri, 12 Dec 2025 22:50:03 -0500 Subject: [PATCH 2/3] fixup --- docs/reference/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 0768f1b26a..4ecf8f8399 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -158,7 +158,7 @@ If left unspecified, ty will try to detect common project layouts and initialize * if a `.//` directory exists, include `.` and `./` in the first party search path * otherwise, default to `.` (flat layout) -Additionally, if a `./python` directory exists and is not a package (i.e. it does not contain an `__init__.py` or `__init__.pyi` file), +Besides, if a `./python` or `./tests` directory exists and is not a package (i.e. it does not contain an `__init__.py` or `__init__.pyi` file), it will also be included in the first party search path. **Default value**: `null` @@ -443,7 +443,7 @@ If left unspecified, ty will try to detect common project layouts and initialize * if a `.//` directory exists, include `.` and `./` in the first party search path * otherwise, default to `.` (flat layout) -Additionally, if a `./python` directory exists and is not a package (i.e. it does not contain an `__init__.py` file), +Besides, if a `./tests` directory exists and is not a package (i.e. it does not contain an `__init__.py` file), it will also be included in the first party search path. **Default value**: `null` From 33008159f3838253d24f5cce9b1d3cd8739f02a0 Mon Sep 17 00:00:00 2001 From: Aria Desires Date: Fri, 12 Dec 2025 22:51:18 -0500 Subject: [PATCH 3/3] fix more --- docs/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules.md b/docs/modules.md index 4b95077ff7..a9e33ab121 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -27,7 +27,7 @@ then set [`environment.root`](./reference/configuration.md#root) in your `pyproj root = ["./app"] ``` -Note a `./python` folder is automatically added to the project `root` if it exists, +Note that a `./python` folder is automatically added to the project `root` if it exists, and is not itself a package (i.e. does not contain an `__init__.py` file or an `__init__.pyi` file).