Skip to content

Commit ce38ab7

Browse files
ucoderylwasser
authored andcommitted
package name consistency
1 parent 635a094 commit ce38ab7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

package-structure-code/python-package-structure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If `tests/` are outside of the **src/package** directory, they aren't included i
9696
9797
By default, Python adds a module in your current working directory to the front of the Python module search path.
9898
99-
This means that if you run your tests in your packages working directory, using a flat layout, `/package/module.py`, Python will discover `package-name/module.py` file before it discovers the installed package.
99+
This means that if you run your tests in your package's working directory, using a flat layout, `/package/module.py`, Python will discover `package/module.py` file before it discovers the installed package.
100100
101101
However, if your package lives in a src/ directory structure **src/package** then it won't be, by default, added to the Python path. This means that when you import your package, Python will be forced to search the active environment (which has your package installed).
102102
@@ -109,7 +109,7 @@ We do not recommend including tests as part of your package wheel by default. Ho
109109

110110
```bash
111111
src/
112-
package-name/
112+
package/
113113
tests/
114114
docs/
115115
```
@@ -185,7 +185,7 @@ The flat layout's primary characteristics are:
185185

186186
- The source code for your package lives in a directory with your package's
187187
name in the root of your directory
188-
- Often the `tests/` directory also lives within that same `package-name` directory.
188+
- Often the `tests/` directory also lives within that same `package` directory.
189189

190190
Below you can see the recommended structure of a scientific Python package
191191
using the flat layout.

0 commit comments

Comments
 (0)