From 250a270a23e4631ff1013ed585ef6fd4bdd7aca0 Mon Sep 17 00:00:00 2001 From: Sumana Harihareswara Date: Sun, 13 Dec 2020 17:27:14 -0500 Subject: [PATCH] docs: Fix small style issues. Signed-off-by: Sumana Harihareswara --- docs/html/user_guide.rst | 14 +++++++------- news/9269.doc | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 news/9269.doc diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 873d413107f..e8218fb785d 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -512,8 +512,8 @@ all users) configuration: else :file:`$HOME/.config/pip/pip.conf`. * On Windows the configuration file is :file:`%APPDATA%\\pip\\pip.ini`. -There are also a legacy per-user configuration file which is also respected, -these are located at: +There is also a legacy per-user configuration file which is also respected. +To find its location: * On Unix and macOS the configuration file is: :file:`$HOME/.pip/pip.conf` * On Windows the configuration file is: :file:`%HOME%\\pip\\pip.ini` @@ -1084,7 +1084,7 @@ You can then install from the archive like this:: $ python -m pip install --force-reinstall --ignore-installed --upgrade --no-index --no-deps $tempdir/* Note that compiled packages are typically OS- and architecture-specific, so -these archives are not necessarily portable across macOShines. +these archives are not necessarily portable across machines. Hash-checking mode can be used along with this method to ensure that future archives are built with identical packages. @@ -1331,7 +1331,7 @@ Backtracking is not a bug, or an unexpected behaviour. It is part of the way pip's dependency resolution process works. During a pip install (e.g. ``pip install tea``), pip needs to work out -the package's dependencies (e.g. ``spoon``, ``hot-water``, ``cup`` etc), the +the package's dependencies (e.g. ``spoon``, ``hot-water``, ``cup`` etc.), the versions of each of these packages it needs to install. For each package pip needs to decide which version is a good candidate to install. @@ -1466,9 +1466,9 @@ here are a number of ways. In most cases, pip will complete the backtracking process successfully. It is possible this could take a very long time to complete - this may -not be the preferred option. +not be your preferred option. -However there is a possibility pip will not be able to find a set of +However, there is a possibility pip will not be able to find a set of compatible versions. If you'd prefer not to wait, you can interrupt pip (ctrl and c) and use @@ -1523,7 +1523,7 @@ suitable constraints file. 4. Be more strict on package dependencies during development ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -For package maintainers during the development, give pip some help by +For package maintainers during software development, give pip some help by creating constraint files for the dependency tree. This will reduce the number of versions it will try. diff --git a/news/9269.doc b/news/9269.doc new file mode 100644 index 00000000000..8e68e0b6213 --- /dev/null +++ b/news/9269.doc @@ -0,0 +1 @@ +Update documentation to reflect that pip still uses legacy resolver by default in Python 2 environments. \ No newline at end of file