Include backtracking in user guide #9040
Conversation
ei8fdb
added
C: dependency resolution
|
@pfmoore thanks for the review. What's the preferred "pip-way" PRs are updated? A subsequent patch made to this PR, or this one to be reverted and 1 single newer PR be made? |
|
You don't need to close the old one and open a new one. You can update your pull request and we recommend you do that (instead of closing the old PR and opening a new one) because then it's easier to see the history of what you've done, to to check that you've responded to previous reviewers' comments, and to preserve links we've mentioned (in comments) with other issues and PRs. |
|
Specifically, just push an extra commit to your branch and the PR will get updated automatically. |
There was a problem hiding this comment.
Thank you @ei8fdb for the work! I have some suggestions - mostly little polish things. I also marked a few places where it would be nice to add some further context for readers, but I am fine with delaying those till a future pull request if you are running short on time!
|
@ei8fdb I think you missed a few review comments that got collapsed by GitHub. |
Co-authored-by: Pradyun Gedam <[email protected]>
docs/html/user_guide.rst
Outdated
| This backtrack behaviour can end in 2 ways - either 1) it will | ||
| successfully find a set of packages it can install (good news!), or 2) it will | ||
| eventually display `resolution impossible <https://pip.pypa.io/en/latest/user_guide/#id35>`__ error | ||
| message (not so good). |
There was a problem hiding this comment.
Maybe we should make this a numbered list?
1. it will successfully..., or
2. it will eventually...
Co-authored-by: Pradyun Gedam <[email protected]> Co-authored-by: Sumana Harihareswara <[email protected]>
|
|
||
| For package maintainers during the development, give pip some help by | ||
| creating constraint files for the dependency tree. This will reduce the | ||
| number of versions it will try. |
There was a problem hiding this comment.
In a later, followup PR, it would be nice for someone to expand this section and add more details.
|
Looks like once you address the notes on lines 1364, 1470, and 1474 we'll be set to merge! |
There was a problem hiding this comment.
@pradyunsg All comments have been ready so this is ready to go. 🥇 😄 Thanks all for the comments.
|
This has failures due to the linters: You can see the errors if you click "Details" for the You can also run the linters locally -- once you have |
|
I just made a commit that would fix the linting issues, and fixes 2 other little things in the docs as well. @pradyunsg feel free to add it to this PR and then merge the PR. |
|
https://github.com/pypa/pip/runs/1334180482#step:8:35 Well, even that commit fails on the linter. :( |
This PR is to include backtracking information in the pip user guide to provide users with information; 1) why this occurs, and 2) how the user can possibly reduce its occurance. (GH issue #9039)
In particular I'd appreciate close review of the section "Possible ways to reduce backtracking occuring" (1-4).