Skip to content

Commit 3fdd630

Browse files
fix: Apply formatting corrections for packaging tutorial
* Amends PR 859 * Adds directory trailing slashes to indicate dir structure for clarity, so abandons `tree` behavior for `ls -F` behavior * Revise phrasing for package_dir description: "collection" -> "mapping" * Clarify the definition of "root package" in the context of the "package_dir"
1 parent 227a942 commit 3fdd630

1 file changed

Lines changed: 15 additions & 12 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ To create this project locally, create the following file structure:
2020

2121
.. code-block:: text
2222
23-
packaging_tutorial
24-
└── src
25-
└── example_pkg
23+
packaging_tutorial/
24+
└── src/
25+
└── example_pkg/
2626
└── __init__.py
2727
2828
Once you create this structure, you'll want to run all of the commands in this
@@ -44,16 +44,16 @@ project's root directory - you will add content to them in the following steps.
4444

4545
.. code-block:: text
4646
47-
packaging_tutorial
47+
packaging_tutorial/
4848
├── LICENSE
4949
├── pyproject.toml
5050
├── README.md
5151
├── setup.cfg
5252
├── setup.py # optional, needed to make editable pip installs work
53-
├── src
54-
│   └── example_pkg
53+
├── src/
54+
│   └── example_pkg/
5555
│   └── __init__.py
56-
└── tests
56+
└── tests/
5757
5858
5959
Creating a test folder
@@ -188,9 +188,10 @@ an escape hatch when absolutely necessary.
188188

189189
In the options category, we have controls for setuptools itself:
190190

191-
- ``package_dir`` is a collection of package names and directories.
192-
An empty package name represents the "root package", so in this
193-
case the root package is in the ``src`` directory.
191+
- ``package_dir`` is a mapping of package names and directories.
192+
An empty package name represents the "root package" --- the directory in
193+
the project that contains all Python source files for the package --- so
194+
in this case the ``src`` directory is designated the root package.
194195
- ``packages`` is a list of all Python :term:`import packages <Import
195196
Package>` that should be included in the :term:`Distribution Package`.
196197
Instead of listing each package manually, we can use the ``find:`` directive
@@ -300,8 +301,10 @@ an escape hatch when absolutely necessary.
300301
your package will work on. For a complete list of classifiers, see
301302
https://pypi.org/classifiers/.
302303
- ``package_dir`` is a dictionary with package names for keys and directories
303-
for values. An empty package name represents the "root package", so in this
304-
case the root package is in the ``src`` directory.
304+
for values. An empty package name represents the "root package" --- the
305+
directory in the project that contains all Python source files for the
306+
package --- so in this case the ``src`` directory is designated the root
307+
package.
305308
- ``packages`` is a list of all Python :term:`import packages <Import
306309
Package>` that should be included in the :term:`Distribution Package`.
307310
Instead of listing each package manually, we can use :func:`find_packages`

0 commit comments

Comments
 (0)