Skip to content

Commit 0db912e

Browse files
tjansonJon Wayne Parrott
authored andcommitted
Fix a handful of typos, missing punctuation (pypa#376)
… in the Distributing Packages doc.
1 parent 66aa3a9 commit 0db912e

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

source/tutorials/distributing-packages.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ this is not a requirement.
8484

8585
For an example, see `README.rst
8686
<https://github.com/pypa/sampleproject/blob/master/README.rst>`_ from the `PyPA
87-
sample project <https://github.com/pypa/sampleproject>`_
87+
sample project <https://github.com/pypa/sampleproject>`_.
8888

8989
MANIFEST.in
9090
~~~~~~~~~~~
@@ -97,7 +97,7 @@ section from the :ref:`distutils` documentation.
9797

9898
For an example, see the `MANIFEST.in
9999
<https://github.com/pypa/sampleproject/blob/master/MANIFEST.in>`_ from the `PyPA
100-
sample project <https://github.com/pypa/sampleproject>`_
100+
sample project <https://github.com/pypa/sampleproject>`_.
101101

102102
For details on writing a ``MANIFEST.in`` file, see the `The MANIFEST.in template
103103
<https://docs.python.org/2/distutils/sourcedist.html#the-manifest-in-template>`_
@@ -116,26 +116,26 @@ If you're unsure which license to choose, you can use resources such as
116116

117117
For an example, see the `LICENSE.txt
118118
<https://github.com/pypa/sampleproject/blob/master/LICENSE.txt>`_ from the `PyPA
119-
sample project <https://github.com/pypa/sampleproject>`_
119+
sample project <https://github.com/pypa/sampleproject>`_.
120120

121121
<your package>
122122
~~~~~~~~~~~~~~
123123

124124
Although it's not required, the most common practice is to include your
125-
python modules and packages under a single top-level package that has the same
125+
Python modules and packages under a single top-level package that has the same
126126
:ref:`name <setup() name>` as your project, or something very close.
127127

128128
For an example, see the `sample
129129
<https://github.com/pypa/sampleproject/tree/master/sample>`_ package that's
130-
include in the `PyPA sample project <https://github.com/pypa/sampleproject>`_
130+
included in the `PyPA sample project <https://github.com/pypa/sampleproject>`_.
131131

132132

133133
.. _`setup() args`:
134134

135135
setup() args
136136
------------
137137

138-
As mentioned above, The primary feature of ``setup.py`` is that it contains a
138+
As mentioned above, the primary feature of ``setup.py`` is that it contains a
139139
global ``setup()`` function. The keyword arguments to this function are how
140140
specific details of your project are defined.
141141

@@ -160,7 +160,7 @@ names must:
160160

161161
- Consist only of ASCII letters, digits, underscores (``_``), hyphens (``-``),
162162
and/or periods (``.``), and
163-
- Start & end with an ASCII letter or digit
163+
- Start & end with an ASCII letter or digit.
164164

165165
Comparison of project names is case insensitive and treats arbitrarily-long
166166
runs of underscores, hyphens, and/or periods as equal. For example, if you
@@ -204,7 +204,7 @@ description
204204
description='A sample Python project',
205205
long_description=long_description,
206206

207-
Give a short and long description for you project. These values will be
207+
Give a short and long description for your project. These values will be
208208
displayed on :term:`PyPI <Python Package Index (PyPI)>` if you publish your
209209
project.
210210

@@ -217,7 +217,7 @@ url
217217
url='https://github.com/pypa/sampleproject',
218218

219219

220-
Give a homepage url for your project.
220+
Give a homepage URL for your project.
221221

222222

223223
author
@@ -612,14 +612,14 @@ dependencies declared with "install_requires" and any scripts declared with
612612

613613
It's fairly common to also want to install some of your dependencies in editable
614614
mode as well. For example, supposing your project requires "foo" and "bar", but
615-
you want "bar" installed from vcs in editable mode, then you could construct a
615+
you want "bar" installed from VCS in editable mode, then you could construct a
616616
requirements file like so::
617617

618618
-e .
619619
-e git+https://somerepo/bar.git#egg=bar
620620

621621
The first line says to install your project and any dependencies. The second
622-
line overrides the "bar" dependency, such that it's fulfilled from vcs, not
622+
line overrides the "bar" dependency, such that it's fulfilled from VCS, not
623623
PyPI.
624624

625625
If, however, you want "bar" installed from a local directory in editable mode, the requirements file should look like this, with the local paths at the top of the file::
@@ -628,7 +628,7 @@ If, however, you want "bar" installed from a local directory in editable mode, t
628628
-e .
629629

630630
Otherwise, the dependency will be fulfilled from PyPI, due to the installation order of the requirements file. For more on requirements files, see the :ref:`Requirements File
631-
<pip:Requirements Files>` section in the pip docs. For more on vcs installs,
631+
<pip:Requirements Files>` section in the pip docs. For more on VCS installs,
632632
see the :ref:`VCS Support <pip:VCS Support>` section of the pip docs.
633633

634634
Lastly, if you don't want to install any dependencies at all, you can run::
@@ -647,7 +647,7 @@ Packaging your Project
647647

648648
To have your project installable from a :term:`Package Index` like :term:`PyPI
649649
<Python Package Index (PyPI)>`, you'll need to create a :term:`Distribution
650-
<Distribution Package>` (aka ":term:`Package <Distribution Package>`" ) for your
650+
<Distribution Package>` (aka ":term:`Package <Distribution Package>`") for your
651651
project.
652652

653653

@@ -663,9 +663,9 @@ Minimally, you should create a :term:`Source Distribution <Source Distribution (
663663
python setup.py sdist
664664

665665

666-
A "source distribution" is unbuilt (i.e, it's not a :term:`Built Distribution`),
666+
A "source distribution" is unbuilt (i.e. it's not a :term:`Built Distribution`),
667667
and requires a build step when installed by pip. Even if the distribution is
668-
pure python (i.e. contains no extensions), it still involves a build step to
668+
pure Python (i.e. contains no extensions), it still involves a build step to
669669
build out the installation metadata from ``setup.py``.
670670

671671

@@ -677,15 +677,15 @@ package <Built Distribution>` that can be installed without needing to go
677677
through the "build" process. Installing wheels is substantially faster for the
678678
end user than installing from a source distribution.
679679

680-
If your project is pure python (i.e. contains no compiled extensions) and
680+
If your project is pure Python (i.e. contains no compiled extensions) and
681681
natively supports both Python 2 and 3, then you'll be creating what's called a
682682
:ref:`*Universal Wheel* (see section below) <Universal Wheels>`.
683683

684-
If your project is pure python but does not natively support both Python 2 and
684+
If your project is pure Python but does not natively support both Python 2 and
685685
3, then you'll be creating a :ref:`"Pure Python Wheel" (see section below) <Pure
686686
Python Wheels>`.
687687

688-
If you project contains compiled extensions, then you'll be creating what's
688+
If your project contains compiled extensions, then you'll be creating what's
689689
called a :ref:`*Platform Wheel* (see section below) <Platform Wheels>`.
690690

691691
Before you can build wheels for your project, you'll need to install the
@@ -701,7 +701,7 @@ Before you can build wheels for your project, you'll need to install the
701701
Universal Wheels
702702
~~~~~~~~~~~~~~~~
703703

704-
*Universal Wheels* are wheels that are pure python (i.e. contains no compiled
704+
*Universal Wheels* are wheels that are pure Python (i.e. contain no compiled
705705
extensions) and support Python 2 and 3. This is a wheel that can be installed
706706
anywhere by :ref:`pip`.
707707

@@ -713,7 +713,7 @@ To build the wheel:
713713
714714
You can also permanently set the ``--universal`` flag in "setup.cfg" (e.g., see
715715
`sampleproject/setup.cfg
716-
<https://github.com/pypa/sampleproject/blob/master/setup.cfg>`_)
716+
<https://github.com/pypa/sampleproject/blob/master/setup.cfg>`_):
717717

718718
.. code-block:: text
719719
@@ -739,8 +739,8 @@ and prevent the possibility of building the extension.
739739
Pure Python Wheels
740740
~~~~~~~~~~~~~~~~~~
741741

742-
*Pure Python Wheels* that are not "universal" are wheels that are pure python
743-
(i.e. contains no compiled extensions), but don't natively support both Python 2
742+
*Pure Python Wheels* that are not "universal" are wheels that are pure Python
743+
(i.e. contain no compiled extensions), but don't natively support both Python 2
744744
and 3.
745745

746746
To build the wheel:
@@ -753,7 +753,7 @@ To build the wheel:
753753
`bdist_wheel` will detect that the code is pure Python, and build a wheel that's
754754
named such that it's usable on any Python installation with the same major
755755
version (Python 2 or Python 3) as the version you used to build the wheel. For
756-
details on the naming of wheel files, see :pep:`425`
756+
details on the naming of wheel files, see :pep:`425`.
757757

758758
If your code supports both Python 2 and 3, but with different code (e.g., you
759759
use `"2to3" <https://docs.python.org/2/library/2to3.html>`_) you can run
@@ -767,7 +767,7 @@ will produce wheels for each version.
767767
Platform Wheels
768768
~~~~~~~~~~~~~~~
769769

770-
*Platform Wheels* are wheels that are specific to a certain platform like linux,
770+
*Platform Wheels* are wheels that are specific to a certain platform like Linux,
771771
macOS, or Windows, usually due to containing compiled extensions.
772772

773773
To build the wheel:
@@ -779,7 +779,7 @@ To build the wheel:
779779

780780
`bdist_wheel` will detect that the code is not pure Python, and build a wheel
781781
that's named such that it's only usable on the platform that it was built
782-
on. For details on the naming of wheel files, see :pep:`425`
782+
on. For details on the naming of wheel files, see :pep:`425`.
783783

784784
.. note::
785785

@@ -798,7 +798,7 @@ was created under your project's root directory. That's where you'll find your
798798
distribution file(s) to upload.
799799

800800
.. note:: Before releasing on main PyPI repo, you might prefer training with
801-
`PyPI test site <https://testpypi.python.org/pypi>`_
801+
the `PyPI test site <https://testpypi.python.org/pypi>`_
802802
which is cleaned on a semi regular basis. See
803803
`these instructions <https://wiki.python.org/moin/TestPyPI>`_ on how
804804
to setup your configuration in order to use it.

0 commit comments

Comments
 (0)