From 64ac23ba1b27bda40a380856d6454d0d139b293e Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 18 Feb 2025 16:18:29 +0530 Subject: [PATCH 1/2] gh-130160: use `.. program::` directive for documenting `ensurepip` CLI --- Doc/library/ensurepip.rst | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst index 8dfb7ad9c95c3e..706ecef26fd6f3 100644 --- a/Doc/library/ensurepip.rst +++ b/Doc/library/ensurepip.rst @@ -43,6 +43,8 @@ when creating a virtual environment) or after explicitly uninstalling Command line interface ---------------------- +.. program:: ensurepip + The command line interface is invoked using the interpreter's ``-m`` switch. The simplest possible invocation is:: @@ -61,26 +63,34 @@ By default, ``pip`` is installed into the current virtual environment active virtual environment). The installation location can be controlled through two additional command line options: -* :samp:`--root {dir}`: Installs ``pip`` relative to the given root directory - rather than the root of the currently active virtual environment (if any) - or the default root for the current Python installation. -* ``--user``: Installs ``pip`` into the user site packages directory rather - than globally for the current Python installation (this option is not - permitted inside an active virtual environment). +.. option:: --root + + Installs ``pip`` relative to the given root directory rather than the root + of the currently active virtual environment (if any) or the default root + for the current Python installation. + +.. option:: --user + + Installs ``pip`` into the user site packages directory rather than globally + for the current Python installation (this option is not permitted inside an + active virtual environment). By default, the scripts ``pipX`` and ``pipX.Y`` will be installed (where X.Y stands for the version of Python used to invoke ``ensurepip``). The scripts installed can be controlled through two additional command line options: -* ``--altinstall``: if an alternate installation is requested, the ``pipX`` - script will *not* be installed. +.. option:: --altinstall -* ``--default-pip``: if a "default pip" installation is requested, the - ``pip`` script will be installed in addition to the two regular scripts. + If an alternate installation is requested, the ``pipX`` script will *not* be + installed. -Providing both of the script selection options will trigger an exception. +.. option:: --default-pip + + If a "default pip" installation is requested, the ``pip`` script will be + installed in addition to the two regular scripts. +Providing both of the script selection options will trigger an exception. Module API ---------- @@ -135,4 +145,4 @@ Module API The bootstrapping process may install additional modules required by ``pip``, but other software should not assume those dependencies will always be present by default (as the dependencies may be removed in a - future version of ``pip``). + future version of ``pip``). \ No newline at end of file From ce0b24e38b43235d5fc1187af35c25a23b796f30 Mon Sep 17 00:00:00 2001 From: Kanishk Pachauri Date: Tue, 18 Feb 2025 16:28:49 +0530 Subject: [PATCH 2/2] chore: fix lint issues --- Doc/library/ensurepip.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst index 706ecef26fd6f3..fa102c4a080103 100644 --- a/Doc/library/ensurepip.rst +++ b/Doc/library/ensurepip.rst @@ -145,4 +145,5 @@ Module API The bootstrapping process may install additional modules required by ``pip``, but other software should not assume those dependencies will always be present by default (as the dependencies may be removed in a - future version of ``pip``). \ No newline at end of file + future version of ``pip``). +