Skip to content

Commit 4b45c5d

Browse files
lwasserucodery
andcommitted
Fix: Edits from @ucodery
Co-authored-by: Jeremiah Paige <[email protected]>
1 parent 65928a8 commit 4b45c5d

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

package-structure-code/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section provides guidance on your Python package's structure, code format,
44
and style. It also reviews the various [packaging tools](python-package-build-tools) you can use to
55
[build](python-package-distribution-files-sdist-wheel) and [publish](publish-python-package-pypi-conda) your Python package.
66

7-
If you want end-to-end tutorials, check out our tutorial series here. That starts by introducing [what a Python package is](what-is-a-package).
7+
If you want end-to-end tutorials, check out our tutorial series that starts by introducing [what a Python package is](what-is-a-package).
88

99
If you are confused by Python packaging, you are not alone! The good news is
1010
that some great modern packaging tools ensure you follow

package-structure-code/python-package-distribution-files-sdist-wheel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ the sdist may also contain a file that stores the version.
226226
```
227227

228228
(python-wheel)=
229-
## What is a Python package wheel (.whl files):
229+
## What is a Python wheel (whl):
230230

231231
A wheel file is a ZIP-format archive whose filename follows a specific format
232232
(below) and has the extension `.whl`. The `.whl` archive contains a specific

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ myPackageRepoName
6060

6161
Note the location of the following directories in the example above:
6262

63-
- **docs/:** discussed in our docs chapter, this directory contains your user-facing documentation website. In a **src/** layout docs/ are normally included at the same directory level as the **src/** folder.
63+
- **docs/:** Discussed in our docs chapter, this directory contains your user-facing documentation website. In a **src/** layout docs/ are normally included at the same directory level as the **src/** folder.
6464
- **tests/** This directory contains the tests for your project code. In a **src/** layout, tests are normally included at the same directory level as the **src/** folder.
6565
- **src/package/**: this is the directory that contains the code for your Python project. "Package" is normally your project's name.
6666

@@ -101,7 +101,7 @@ working directory. If you run your tests on your files rather than the
101101
installed version of your package, you may be missing issues that users encounter when
102102
your package is installed.
103103

104-
If `tests/` are outside the **src/package** directory, they aren't included in the package [wheel](python-wheel). This makes your package size slightly smaller, which places a smaller storage burden on PyPI, which has over 400,000 packages to support.
104+
If `tests/` are outside the **src/package** directory, they aren't included in the package's [wheel](python-wheel). This makes your package size slightly smaller, which places a smaller storage burden on PyPI, and makes them faster to fetch.
105105

106106
- [Read more about reasons to use the **src/package** layout](https://hynek.me/articles/testing-packaging/)
107107

0 commit comments

Comments
 (0)