Skip to content

Commit

Permalink
Fix docs issues (#3999)
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri authored Aug 2, 2023
2 parents 80e60c3 + d327cbf commit 77c14a8
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/deprecated/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,8 @@ installation options for dependencies.
this option is automatically in effect, because ``.pth`` files can only be
used in ``site-packages`` (at least in Python 2.3 and 2.4). So, if you use
the ``--install-dir`` or ``-d`` option (or they are set via configuration
file(s)) your project and its dependencies will be deployed in multi-
version mode.
file(s)) your project and its dependencies will be deployed in
multi-version mode.

``--install-dir=DIR, -d DIR``
Set the installation directory (staging area). If this option is not
Expand Down
22 changes: 11 additions & 11 deletions docs/pkg_resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,10 +228,10 @@ affected distribution is activated. For example::
Basic ``WorkingSet`` Methods
----------------------------

The following methods of ``WorkingSet`` objects are also available as module-
level functions in ``pkg_resources`` that apply to the default ``working_set``
instance. Thus, you can use e.g. ``pkg_resources.require()`` as an
abbreviation for ``pkg_resources.working_set.require()``:
The following methods of ``WorkingSet`` objects are also available as
module-level functions in ``pkg_resources`` that apply to the default
``working_set`` instance. Thus, you can use e.g. ``pkg_resources.require()``
as an abbreviation for ``pkg_resources.working_set.require()``:


``require(*requirements)``
Expand Down Expand Up @@ -1552,11 +1552,11 @@ Parsing Utilities
.. _yield_lines():

``yield_lines(strs)``
Yield non-empty/non-comment lines from a string/unicode or a possibly-
nested sequence thereof. If ``strs`` is an instance of ``basestring``, it
is split into lines, and each non-blank, non-comment line is yielded after
stripping leading and trailing whitespace. (Lines whose first non-blank
character is ``#`` are considered comment lines.)
Yield non-empty/non-comment lines from a string/unicode or a
possibly-nested sequence thereof. If ``strs`` is an instance of
``basestring``, it is split into lines, and each non-blank, non-comment
line is yielded after stripping leading and trailing whitespace. (Lines
whose first non-blank character is ``#`` are considered comment lines.)

If ``strs`` is not an instance of ``basestring``, it is iterated over, and
each item is passed recursively to ``yield_lines()``, so that an arbitrarily
Expand Down Expand Up @@ -1887,8 +1887,8 @@ History
* Fixed a bug in resource extraction from nested packages in a zipped egg.

0.5a12
* Updated extraction/cache mechanism for zipped resources to avoid inter-
process and inter-thread races during extraction. The default cache
* Updated extraction/cache mechanism for zipped resources to avoid
inter-process and inter-thread races during extraction. The default cache
location can now be set via the ``PYTHON_EGGS_CACHE`` environment variable,
and the default Windows cache is now a ``Python-Eggs`` subdirectory of the
current user's "Application Data" directory, if the ``PYTHON_EGGS_CACHE``
Expand Down
10 changes: 5 additions & 5 deletions docs/userguide/distribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ equal to "final", or a dash (``-``) - for example ``2.4-r1263`` or

Notice that after each legacy pre or post-release tag, you are free to place
another release number, followed again by more pre- or post-release tags. For
example, ``0.6a9.dev41475`` could denote Subversion revision 41475 of the in-
development version of the ninth alpha of release 0.6. Notice that ``dev`` is
a pre-release tag, so this version is a *lower* version number than ``0.6a9``,
which would be the actual ninth alpha of release 0.6. But the ``41475`` is
a post-release tag, so this version is *newer* than ``0.6a9.dev``.
example, ``0.6a9.dev41475`` could denote Subversion revision 41475 of the
in-development version of the ninth alpha of release 0.6. Notice that ``dev``
is a pre-release tag, so this version is a *lower* version number than
``0.6a9``, which would be the actual ninth alpha of release 0.6. But the
``41475`` is a post-release tag, so this version is *newer* than ``0.6a9.dev``.

For the most part, setuptools' interpretation of version numbers is intuitive,
but here are a few tips that will keep you out of trouble in the corner cases:
Expand Down
3 changes: 3 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ extras =
docs
testing
changedir = docs
deps =
importlib_resources < 6 # twisted/towncrier#528 (waiting for release)
commands =
python -m sphinx -W --keep-going . {toxinidir}/build/html
python -m sphinxlint
Expand All @@ -50,6 +52,7 @@ deps =
towncrier
bump2version
jaraco.develop >= 7.23
importlib_resources < 6 # twisted/towncrier#528 (waiting for release)
passenv = *
commands =
python tools/finalize.py
Expand Down

0 comments on commit 77c14a8

Please sign in to comment.