Skip to content

Commit

Permalink
Doc nits
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Lawson committed Jul 21, 2016
1 parent 5337d01 commit 72d9fd1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions docs/reference/pip_download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ directory). This directory can later be passed as the value to ``pip install
``pip download`` with the ``--platform``, ``--python-version``,
``--implementation``, and ``--abi`` options provides the ability to fetch
dependencies for an interpreter and system other than the ones that pip is
running on. ``--only-binary=:all:`` is required when using any of these
options. It is important to note that these options all default to the
running on. ``--only-binary=:all:`` is required when using any of these
options. It is important to note that these options all default to the
current system/interpreter, and not to the most restrictive constraints (e.g.
platform any, abi none, etc). To avoid fetching dependencies that happen to
match the constraint of the current interpreter (but not your target one), it
Expand All @@ -55,19 +55,19 @@ Options
Examples
********

#. Download a package and all of its dependencies
#. Download a package and all of its dependencies

::

$ pip download SomePackage
$ pip download -d . SomePackage # equivalent to above
$ pip download --no-index --find-links=/tmp/wheelhouse -d /tmp/otherwheelhouse SomePackage

#. Download a package and all of its dependencies with OSX specific interpreter constraints.
#. Download a package and all of its dependencies with OSX specific interpreter constraints.
This forces OSX 10.10 or lower compatibility. Since OSX deps are forward compatible,
this will also match ``macosx-10_9_x86_64``, ``macosx-10_8_x86_64``, ``macosx-10_8_intel``,
etc.
It will also match deps with platform ``any``. Also force the interpreter version to ``27``
It will also match deps with platform ``any``. Also force the interpreter version to ``27``
(or more generic, i.e. ``2``) and implementation to ``cp`` (or more generic, i.e. ``py``).

::
Expand All @@ -79,7 +79,7 @@ Examples
--implementation cp \
SomePackage

#. Download a package and its dependencies with linux specific constraints.
#. Download a package and its dependencies with linux specific constraints.
Force the interpreter to be any minor version of py3k, and only accept
``cp34m`` or ``none`` as the abi.

Expand All @@ -93,7 +93,7 @@ Examples
--abi cp34m \
SomePackage

#. Force platform, implementation, and abi agnostic deps.
#. Force platform, implementation, and abi agnostic deps.

::

Expand All @@ -105,7 +105,7 @@ Examples
--abi none \
SomePackage

#. Even when overconstrained, this will still correctly fetch the pip universal wheel.
#. Even when overconstrained, this will still correctly fetch the pip universal wheel.

::

Expand Down
2 changes: 1 addition & 1 deletion pip/commands/download.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def __init__(self, *args, **kw):
metavar='platform',
default=None,
help=("Only download wheels compatible with <platform>. "
"Defaults to the platform of the local computer."),
"Defaults to the platform of the running system."),
)

cmd_opts.add_option(
Expand Down

0 comments on commit 72d9fd1

Please sign in to comment.