1
1
Fork 0
mirror of https://github.com/pypa/pip synced 2023-12-13 21:30:23 +01:00

Improve some PackageFinder methods' docstrings

This commit is contained in:
Xavier Fernandez 2015-09-04 22:36:32 +02:00
parent 9c43dbcac4
commit 7d596224cd

View file

@ -345,8 +345,8 @@ class PackageFinder(object):
def _find_all_versions(self, project_name): def _find_all_versions(self, project_name):
"""Find all available versions for project_name """Find all available versions for project_name
This checks index_urls, find_links and dependency_links This checks index_urls, find_links and dependency_links.
All versions found are returned All versions found are returned as an InstallationCandidate list.
See _link_package_versions for details on which files are accepted See _link_package_versions for details on which files are accepted
""" """
@ -426,11 +426,11 @@ class PackageFinder(object):
) )
def find_requirement(self, req, upgrade): def find_requirement(self, req, upgrade):
"""Try to find an InstallationCandidate for req """Try to find a Link matching req
Expects req, an InstallRequirement and upgrade, a boolean Expects req, an InstallRequirement and upgrade, a boolean
Returns a Link or None Returns a Link if found,
May raise DistributionNotFound or BestVersionAlreadyInstalled Raises DistributionNotFound or BestVersionAlreadyInstalled otherwise
""" """
all_versions = self._find_all_versions(req.name) all_versions = self._find_all_versions(req.name)