Skip to content
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

Jump to bottom

Remove pip list legacy format from documentation #10366

Merged
merged 1 commit into from
Aug 15, 2021
Merged

Remove pip list legacy format from documentation #10366

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
80 changes: 10 additions & 70 deletions docs/html/cli/pip_list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,55 +35,13 @@ Options
Examples
========

#. List installed packages.
#. List installed packages (with the default column formatting).

.. tab:: Unix/macOS

.. code-block:: console

$ python -m pip list
docutils (0.10)
Jinja2 (2.7.2)
MarkupSafe (0.18)
Pygments (1.6)
Sphinx (1.2.1)

.. tab:: Windows

.. code-block:: console

C:\> py -m pip list
docutils (0.10)
Jinja2 (2.7.2)
MarkupSafe (0.18)
Pygments (1.6)
Sphinx (1.2.1)

#. List outdated packages (excluding editables), and the latest version available.

.. tab:: Unix/macOS

.. code-block:: console

$ python -m pip list --outdated
docutils (Current: 0.10 Latest: 0.11)
Sphinx (Current: 1.2.1 Latest: 1.2.2)

.. tab:: Windows

.. code-block:: console

C:\> py -m pip list --outdated
docutils (Current: 0.10 Latest: 0.11)
Sphinx (Current: 1.2.1 Latest: 1.2.2)

#. List installed packages with column formatting.

.. tab:: Unix/macOS

.. code-block:: console

$ python -m pip list --format columns
Package Version
------- -------
docopt 0.6.2
Expand All @@ -94,7 +52,7 @@ Examples

.. code-block:: console

C:\> py -m pip list --format columns
C:\> py -m pip list
Package Version
------- -------
docopt 0.6.2
Expand All @@ -107,7 +65,7 @@ Examples

.. code-block:: console

$ python -m pip list -o --format columns
$ python -m pip list --outdated --format columns
Package Version Latest Type
---------- ------- ------ -----
retry 0.8.1 0.9.1 wheel
Expand All @@ -117,7 +75,7 @@ Examples

.. code-block:: console

C:\> py -m pip list -o --format columns
C:\> py -m pip list --outdated --format columns
Package Version Latest Type
---------- ------- ------ -----
retry 0.8.1 0.9.1 wheel
Expand All @@ -131,36 +89,18 @@ Examples
.. code-block:: console

$ python -m pip list --outdated --not-required
docutils (Current: 0.10 Latest: 0.11)
Package Version Latest Type
-------- ------- ------ -----
docutils 0.14 0.17.1 wheel

.. tab:: Windows

.. code-block:: console

C:\> py -m pip list --outdated --not-required
docutils (Current: 0.10 Latest: 0.11)

#. Use legacy formatting

.. tab:: Unix/macOS

.. code-block:: console

$ python -m pip list --format=legacy
colorama (0.3.7)
docopt (0.6.2)
idlex (1.13)
jedi (0.9.0)

.. tab:: Windows

.. code-block:: console

C:\> py -m pip list --format=legacy
colorama (0.3.7)
docopt (0.6.2)
idlex (1.13)
jedi (0.9.0)
Package Version Latest Type
-------- ------- ------ -----
docutils 0.14 0.17.1 wheel

#. Use json formatting

Expand Down