Correct the docstrings for resolve_requires

This commit is contained in:
mprahl
2018-10-16 09:32:50 -04:00
parent 8ef445c0b2
commit 7a2ea6f366
2 changed files with 8 additions and 17 deletions

View File

@@ -175,7 +175,7 @@ class DBResolver(GenericResolver):
If there are some modules loaded by utils.load_local_builds(...), these
local modules will be considered when resolving the requires. A RuntimeError
is raised on DB lookup errors.
:param requires: a dictionary with the module name as the key and the stream as the value
:param requires: a list of N:S or N:S:V:C strings
:return: a dictionary
"""
new_requires = {}

View File

@@ -272,23 +272,14 @@ class MBSResolver(GenericResolver):
def resolve_requires(self, requires):
"""
Takes `requires` dict with module_name as key and module_stream as value.
Resolves the stream to particular latest version of a module and returns
new dict in following format:
{
"module_name": {
"ref": module_commit_hash,
"stream": original_module_stream,
"version": module_version
},
...
}
Resolves the requires list of N:S or N:S:V:C to a dictionary with keys as
the module name and the values as a dictionary with keys of ref,
stream, version.
If there are some modules loaded by utils.load_local_builds(...), these
local modules will be considered when resolving the requires.
Raises RuntimeError on MBS lookup error.
local modules will be considered when resolving the requires. A RuntimeError
is raised on MBS lookup errors.
:param requires: a list of N:S or N:S:V:C strings
:return: a dictionary
"""
new_requires = {}
for nsvc in requires: