Skip to content

Commit 83098f7

Browse files
committed
Tweak package naming suggestions
1 parent f6a1cfe commit 83098f7

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -118,15 +118,14 @@ an escape hatch when absolutely necessary.
118118
code files to include. Eventually much of this configuration may be able to move
119119
to :file:`pyproject.toml`.
120120

121-
Open :file:`setup.cfg` and enter the following content. Update the package name
122-
to include your username (for example, ``example-pkg-theacodes``), this ensures
123-
that you have a unique package name and that your package doesn't conflict with
124-
packages uploaded by other people following this tutorial.
121+
Open :file:`setup.cfg` and enter the following content. Change the ``name``
122+
to include your username; this ensures that you have a unique package name
123+
and that your package doesn't conflict with packages uploaded by other
124+
people following this tutorial.
125125

126126
.. code-block:: python
127127
128128
[metadata]
129-
# replace with your username:
130129
name = example-pkg-YOUR-USERNAME-HERE
131130
version = 0.0.1
132131
author = Example Author
@@ -234,10 +233,10 @@ an escape hatch when absolutely necessary.
234233
about your package (such as the name and version) as well as which code files
235234
to include.
236235

237-
Open :file:`setup.py` and enter the following content. Update the package name
238-
to include your username (for example, ``example-pkg-theacodes``), this ensures
239-
that you have a unique package name and that your package doesn't conflict with
240-
packages uploaded by other people following this tutorial.
236+
Open :file:`setup.py` and enter the following content. Change the ``name``
237+
to include your username; this ensures that you have a unique package name
238+
and that your package doesn't conflict with packages uploaded by other
239+
people following this tutorial.
241240

242241
.. code-block:: python
243242
@@ -247,7 +246,7 @@ an escape hatch when absolutely necessary.
247246
long_description = fh.read()
248247
249248
setuptools.setup(
250-
name="example-pkg-YOUR-USERNAME-HERE", # Replace with your own username
249+
name="example-pkg-YOUR-USERNAME-HERE",
251250
version="0.0.1",
252251
author="Example Author",
253252
author_email="author@example.com",

0 commit comments

Comments
 (0)