Skip to content
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

Finder found candidates cleanup #6415

Merged
merged 7 commits into from
Apr 20, 2019

Conversation

uranusjr
Copy link
Member

Follow-up cleaning mentioned in #5971

src/pip/_internal/index.py Outdated Show resolved Hide resolved
Copy link
Member

@cjerdonek cjerdonek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the quick turnaround. Some comments.

src/pip/_internal/index.py Outdated Show resolved Hide resolved
src/pip/_internal/index.py Outdated Show resolved Hide resolved
@@ -288,22 +317,10 @@ def iter_all(self):

def iter_applicable(self):
# type: () -> Iterable[InstallationCandidate]
"""Iterate through candidates matching the given specifier.
"""Iterate through candidates matching the given versions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say something other than "given" here because the versions are associated with the object rather than given as arguments (which is what given normally means in the context of a function or method docstring).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the current wording better? (I am not good at describing things.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a big deal. But some other possibilities that come to mind: "Iterate through the candidates matching the instance's versions." or "matching the versions associated with the instance" or "matching the associated versions"

src/pip/_internal/index.py Outdated Show resolved Hide resolved
@cjerdonek cjerdonek added C: finder PackageFinder and index related code skip news Does not need a NEWS file entry (eg: trivial changes) type: refactor Refactoring code labels Apr 17, 2019
@uranusjr uranusjr force-pushed the finder-found-candidates-cleanup branch from 650d3ee to f499e11 Compare April 18, 2019 07:23
@uranusjr uranusjr force-pushed the finder-found-candidates-cleanup branch from f499e11 to 288f5b9 Compare April 18, 2019 07:25
@uranusjr
Copy link
Member Author

Changed the default specifier arg to None, and store versions as Set[str] instead.

@cjerdonek cjerdonek merged commit 1ef8857 into pypa:master Apr 20, 2019
@cjerdonek
Copy link
Member

Good work! 👍Looks great!

@uranusjr uranusjr deleted the finder-found-candidates-cleanup branch May 2, 2019 05:34
@lock
Copy link

lock bot commented Jun 1, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 1, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Jun 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation C: finder PackageFinder and index related code skip news Does not need a NEWS file entry (eg: trivial changes) type: refactor Refactoring code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants