-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add resolver docs #8493
Add resolver docs #8493
Conversation
I'm not enough of a ReST expert to comment on the markup, but the content looks good to me. |
@nlhkabu Pull Requests on pip's tracker automatically get their documentation built + made available for preview. It's a check called "docs/readthedocs.org:pip" in the list of checks on the PR, and "details" link on it, points to the preview. The section added in this PR is available at: https://pip--8493.org.readthedocs.build/en/8493/user_guide/#fixing-conflicting-dependencies Any changes made on this PR will also get reflected on that page. :) |
TIL! :-) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great document -- thank you for putting it together! I like the structure and the content and the clear writing with concrete examples.
Hi @nlhkabu Just as a suggestion, you can also add multiple review suggestions to a batch, and apply all of them under a single commit, instead of one commit per suggestion. This is also described in the 2nd sub point of the 3rd point at https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request
|
Hi @deveshks - yes, I saw that, but unfortunately the "Add suggestion to batch" button was disabled on GitHub. Not sure if it has something to do with my permissions on this project. I will squash the commits to clean up the commit history before finalising the PR. |
@nlhkabu for batch suggestions, you need to go into the files view. (the disabled button in the other view has a tooltip indicating this) |
I think this is good to go. Let's go ahead and merge this now -- we can iterate on this in the future as needed. To that end, @nlhkabu could you please rebase this on master (to resolver the Travis CI failures) and add a |
Yep @pradyunsg just making some edits on my side (both formatting and content). Hope to submit for merge today. |
519381e
to
b77670e
Compare
This is now ready for final review: https://pip--8493.org.readthedocs.build/en/8493/user_guide/#fixing-conflicting-dependencies If we're happy with this, I'll add NEWS and clean up the commit history. Note: I didn't convert the table to a definition list, as I was not sure where to put the examples in that format. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to merge once a NEWS entry is added! ^>^
b77670e
to
909f50a
Compare
@pradyunsg this is ready to go on my side. |
@nlhkabu, the commit you're basing this PR on has them failed to. I'm not sure if that's necessary, but to get rid of the red cross you can rebase it on current master which is green. |
@McSinyx's analysis is correct, but the failing checks aren't a blocker for merging this PR. I can merge it once I'm on my PC (GitHub doesn't let me merge from a mobile device if any CI check fails). |
ping @pradyunsg for merge :) |
Thanks for the ping @nlhkabu! ^>^ |
Closes #8459
TODO: