Skip to content

update implicit root docs #1869

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
Gankra merged 3 commits into from
Dec 13, 2025
Merged

update implicit root docs #1869

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef4d00a
update implicit root docs
Gankra Dec 12, 2025
64b6dbd
fixup
Gankra Dec 13, 2025
3300815
fix more
Gankra Dec 13, 2025
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
4 changes: 2 additions & 2 deletions docs/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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
Comment on lines +30 to +31
Copy link
Contributor

@carljm carljm Dec 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we discuss this down here, separately from the mention of ./src above? Isn't the treatment of ./python the same as the treatment of ./src? (I realize that choice predates this PR.)

Copy link
Contributor Author

@Gankra Gankra Dec 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm other variants of this doc seemed to suggest there were two mutually exclusive "layout modes" we detected, but the ./python addition was applicable to both.

Copy link
Contributor

@carljm carljm Dec 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is the case...

`__init__.pyi` file).

## Third-party modules
Expand Down