Skip to content

Fix documentation grammar, typos, and formatting #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DimitriPapadopoulos wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix documentation grammar, typos, and formatting #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/distutils/apiref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ API Reference


The :mod:`distutils.core` module is the only module that needs to be installed
to use the Distutils. It provides the :func:`setup` (which is called from the
setup script). Indirectly provides the :class:`distutils.dist.Distribution` and
:class:`distutils.cmd.Command` class.
to use the Distutils. It provides the :func:`setup` function (which is called
from the setup script) and indirectly provides the
:class:`distutils.dist.Distribution` and :class:`distutils.cmd.Command` class.


.. function:: setup(arguments)
Expand Down
9 changes: 4 additions & 5 deletions docs/distutils/builtdist.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,7 @@ Distutils configuration files. Various options and sections in the
| Version | ``version`` |
+------------------------------------------+----------------------------------------------+
| Vendor | ``author`` and ``author_email``, |
| | or --- & ``maintainer`` and |
| | ``maintainer_email`` |
| | or ``maintainer`` and ``maintainer_email`` |
+------------------------------------------+----------------------------------------------+
| Copyright | ``license`` |
+------------------------------------------+----------------------------------------------+
Expand Down Expand Up @@ -294,7 +293,7 @@ installed, you can use a 32bit version of Windows to create 64bit extensions
and vice-versa.

To build for an alternate platform, specify the :option:`!--plat-name` option
to the build command. Valid values are currently 'win32', and 'win-amd64'.
to the build command. Valid values are currently 'win32', and 'win-amd64'.
For example, on a 32bit version of Windows, you could execute::

python setup.py build --plat-name=win-amd64
Expand All @@ -317,8 +316,8 @@ check or modify your existing install.)

.. _postinstallation-script:

The Postinstallation script
---------------------------
The Post-installation script
----------------------------

Starting with Python 2.3, a postinstallation script can be specified with the
:option:`!--install-script` option. The basename of the script must be
Expand Down
14 changes: 7 additions & 7 deletions docs/distutils/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ setup might look like this::
foo.py
bar.py

and the setup script might be ::
and the setup script might be ::

from distutils.core import setup
setup(name='foobar',
Expand All @@ -82,7 +82,7 @@ can just tell the Distutils to process modules from the root package, and that
works the same as any other package (except that you don't have to have an
:file:`__init__.py` file).

The setup script from the last example could also be written as ::
The setup script from the last example could also be written as ::

from distutils.core import setup
setup(name='foobar',
Expand Down Expand Up @@ -142,7 +142,7 @@ need to use the ``package_dir`` option again. For example, if the
foo.py
bar.py

an appropriate setup script would be ::
an appropriate setup script would be ::

from distutils.core import setup
setup(name='foobar',
Expand All @@ -160,7 +160,7 @@ root::
foo.py
bar.py

in which case your setup script would be ::
in which case your setup script would be ::

from distutils.core import setup
setup(name='foobar',
Expand All @@ -187,7 +187,7 @@ figure out which directories correspond to Python packages by looking for
__init__.py
blah.py

then the corresponding setup script would be ::
then the corresponding setup script would be ::

from distutils.core import setup
setup(name='foobar',
Expand All @@ -211,7 +211,7 @@ single extension module in a single C source file, is::
foo.c

If the :mod:`foo` extension belongs in the root package, the setup script for
this could be ::
this could be ::

from distutils.core import setup
from distutils.extension import Extension
Expand Down Expand Up @@ -322,7 +322,7 @@ You can read back this static file, by using the
'Easily download, build, install, upgrade, and uninstall Python packages'

Notice that the class can also be instantiated with a metadata file path to
loads its values::
load its values::

>>> pkg_info_path = 'distribute-0.6.8-py2.7.egg-info'
>>> DistributionMetadata(pkg_info_path).name
Expand Down
Loading