Improve docs on resolver, constraints, and hash-checking

Related to pypa#9020.
brainwane · Oct 27, 2020 · 8445007 · 8445007
1 parent cab055d
commit 8445007
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst
@@ -1435,7 +1435,15 @@ install x y`` in a single command. We would like your thoughts on what
 pip's behavior should be; please answer `our survey on upgrades that
 create conflicts`_.
 
-We are also changing our support for :ref:`Constraints Files`:
+We are also changing our support for :ref:`Constraints Files` and related functionality:
+
+* Constraints don't override the existing requirements; they simply
+  constrain what versions are visible as input to the resolver (see
+  :issue:`9020`)
+
+* Hash-checking mode requires that all requirements are specified as a
+`==` match on a version and may not work well in combination with
+constraints (see :issue:`9020`)
 
 * Unnamed requirements are not allowed as constraints (see :issue:`6628` and :issue:`8210`)
 * Links are not allowed as constraints (see :issue:`8253`)

diff --git a/news/9056.doc.rst b/news/9056.doc.rst
@@ -0,0 +1 @@
+Improve migration guide to reflect changes in new resolver behavior.