From 27b4980c6c747b10818fcaf11f0fe1bad72754fb Mon Sep 17 00:00:00 2001 From: Sumana Harihareswara Date: Thu, 30 Jul 2020 13:58:47 -0400 Subject: [PATCH] Update documentation to reflect updated resolver feature flag Followup to #8371, #8530, #8513. --- .github/ISSUE_TEMPLATE/bug-report.md | 2 +- docs/html/user_guide.rst | 16 ++++++++-------- news/8660.doc | 1 + 3 files changed, 10 insertions(+), 9 deletions(-) create mode 100644 news/8660.doc diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index fdefbe1a431..157be28b678 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -4,7 +4,7 @@ about: Create a report to help us improve --- **Environment** diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst index 702a97d0ca1..31887a2880c 100644 --- a/docs/html/user_guide.rst +++ b/docs/html/user_guide.rst @@ -783,7 +783,7 @@ specified packages due to conflicting dependencies (a ``ResolutionImpossible`` error). This documentation is specific to the new resolver, which you can use -with the flag ``--unstable-feature=resolver``. +with the flag ``--use-feature=2020-resolver``. Understanding your error message -------------------------------- @@ -1029,13 +1029,13 @@ Changes to the pip dependency resolver in 20.2 (2020) ===================================================== pip 20.1 included an alpha version of the new resolver (hidden behind -an optional ``--unstable-feature=resolver`` flag). pip 20.2 includes a -robust beta of the new resolver (hidden behind an optional -``--use-feature=2020-resolver`` flag) that we encourage you to -test. We will continue to improve the pip dependency resolver in -response to testers' feedback. Please give us feedback through the -`resolver testing survey`_. This will help us prepare to release pip -20.3, with the new resolver on by default, in October. +an optional ``--unstable-feature=resolver`` flag). pip 20.2 removes +that flag, and includes a robust beta of the new resolver (hidden +behind an optional ``--use-feature=2020-resolver`` flag) that we +encourage you to test. We will continue to improve the pip dependency +resolver in response to testers' feedback. Please give us feedback +through the `resolver testing survey`_. This will help us prepare to +release pip 20.3, with the new resolver on by default, in October. Watch out for ------------- diff --git a/news/8660.doc b/news/8660.doc new file mode 100644 index 00000000000..45b71cc26a4 --- /dev/null +++ b/news/8660.doc @@ -0,0 +1 @@ +Fix feature flag name in docs.