diff --git a/docs/deprecated/easy_install.rst b/docs/deprecated/easy_install.rst index ab3d38a061..8dedb2edef 100644 --- a/docs/deprecated/easy_install.rst +++ b/docs/deprecated/easy_install.rst @@ -42,7 +42,7 @@ You will need at least Python 3.5 or 2.7. An ``easy_install`` script will be installed in the normal location for Python scripts on your platform. Note that the instructions on the setuptools PyPI page assume that you are -are installing to Python's primary ``site-packages`` directory. If this is +installing to Python's primary ``site-packages`` directory. If this is not the case, you should consult the section below on `Custom Installation Locations`_ before installing. (And, on Windows, you should not use the ``.exe`` installer when installing to an alternate location.) diff --git a/docs/deprecated/index.rst b/docs/deprecated/index.rst index 9db1729a40..b1ebd15235 100644 --- a/docs/deprecated/index.rst +++ b/docs/deprecated/index.rst @@ -3,7 +3,7 @@ Guides on backward compatibility & deprecated practice ====================================================== ``Setuptools`` has undergone tremendous changes since its first debut. As its -development continues to roll forward, many of the practice and mechanisms it +development continues to roll forward, many of the practices and mechanisms it had established are now considered deprecated. But they still remain relevant as a plethora of libraries continue to depend on them. Many people also find it necessary to equip themselves with the knowledge to better support backward diff --git a/docs/references/keywords.rst b/docs/references/keywords.rst index 41d30c33d4..f6a533fc4e 100644 --- a/docs/references/keywords.rst +++ b/docs/references/keywords.rst @@ -54,7 +54,7 @@ extensions). .. _keyword/long_description_content_type: ``long_description_content_type`` - A string specifying the content type is used for the ``long_description`` + A string specifying the content type used for the ``long_description`` (e.g. ``text/markdown``) .. _keyword/author: diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index fd9947ee79..c4bf5e0f78 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -6,7 +6,7 @@ The first step towards sharing a Python library or program is to build a distribution package [#package-overload]_. This includes adding a set of additional files containing metadata and configuration to not only instruct ``setuptools`` on how the distribution should be built but also -to help installer (such as :pypi:`pip`) during the installation process. +to help installers (such as :pypi:`pip`) during the installation process. This document contains information to help Python developers through this process. Please check the :doc:`/userguide/quickstart` for an overview of diff --git a/docs/userguide/interfaces.rst b/docs/userguide/interfaces.rst index ad747b48d5..f8fe0f574d 100644 --- a/docs/userguide/interfaces.rst +++ b/docs/userguide/interfaces.rst @@ -54,7 +54,7 @@ carefully attempt to find alternatives before resorting to unscheduled removals. In the context of ``setuptools``, the introduction of :py:mod:`warnings` (including deprecation warnings) is not considered a breaking change *per se*. Instead it is considered a backwards compatible *communication action* that - precedes an upcoming breaking change. This is becauset code + precedes an upcoming breaking change. This is because code containing warnings typically does not fail and can successfully terminate execution, unless users explicitly opt into transforming those warnings into errors (e.g., via Python's :external+python:ref:`-W option or diff --git a/docs/userguide/miscellaneous.rst b/docs/userguide/miscellaneous.rst index 1b493fba3b..6141a063cf 100644 --- a/docs/userguide/miscellaneous.rst +++ b/docs/userguide/miscellaneous.rst @@ -24,7 +24,7 @@ files are included in a source distribution by default: in ``pyproject.toml`` and/or equivalent in ``setup.cfg``/``setup.py``; note that if you don't explicitly set this parameter, ``setuptools`` will include any files that match the following glob patterns: - ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS**``; + ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``; - ``pyproject.toml``; - ``setup.cfg``; - ``setup.py``; diff --git a/docs/userguide/pyproject_config.rst b/docs/userguide/pyproject_config.rst index 0b37749064..b1f4b9f97e 100644 --- a/docs/userguide/pyproject_config.rst +++ b/docs/userguide/pyproject_config.rst @@ -170,7 +170,7 @@ existing packages should consider migrating to alternatives. packages = ["my_package"] If you want to publish a distribution that does not include any Python module - (e.g. a "meta-distribution" that just aggregate dependencies), please + (e.g. a "meta-distribution" that just aggregates dependencies), please consider something like the following: .. code-block:: toml diff --git a/docs/userguide/quickstart.rst b/docs/userguide/quickstart.rst index 606654f86c..4138f48865 100644 --- a/docs/userguide/quickstart.rst +++ b/docs/userguide/quickstart.rst @@ -9,7 +9,7 @@ You can install the latest version of ``setuptools`` using :pypi:`pip`:: pip install --upgrade setuptools[core] -Most of the times, however, you don't have to... +Most of the time, however, you don't have to... Instead, when creating new Python packages, it is recommended to use a command line tool called :pypi:`build`. This tool will automatically download @@ -33,7 +33,7 @@ This will allow you to run the command: ``python -m build``. check out :doc:`pip installation docs `. -Every python package must provide a ``pyproject.toml`` and specify +Every Python package must provide a ``pyproject.toml`` and specify the backend (build system) it wants to use. The distribution can then be generated with whatever tool that provides a ``build sdist``-like functionality. @@ -200,7 +200,7 @@ Package discovery For projects that follow a simple directory structure, ``setuptools`` should be able to automatically detect all :term:`packages ` and :term:`namespaces `. However, complex projects might include -additional folders and supporting files that not necessarily should be +additional folders and supporting files that should not necessarily be distributed (or that can confuse ``setuptools`` auto discovery algorithm). Therefore, ``setuptools`` provides a convenient way to customize