Skip to content

Commit

Permalink
Merge pull request #844 from sirosen/missing-docparams-cleanup-experi…
Browse files Browse the repository at this point in the history
…mental

Fix missing docparams in experimental/
  • Loading branch information
sirosen authored Aug 28, 2023
2 parents fda90c6 + 5740a94 commit 948253a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion src/globus_sdk/experimental/scope_parser/scope_definition.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ def parse(scope_string: str) -> list[Scope]:
However, this also means that the parsing does not allow for strings which
represent consent trees with structures in which the same scope appears in
multiple parts of the tree.
:param scope_string: The string to parse
:type scope_string: str
"""
scope_graph = parse_scope_graph(scope_string)

Expand All @@ -79,7 +82,11 @@ def deserialize(cls, scope_string: str) -> Scope:
Deserialize a scope string to a scope object.
This is the special case of parsing in which exactly one scope must be returned
by the parse.
by the parse. If more than one scope is returned by the parse, a ``ValueError``
will be raised.
:param scope_string: The string to parse
:type scope_string: str
"""
data = Scope.parse(scope_string)
if len(data) != 1:
Expand Down

0 comments on commit 948253a

Please sign in to comment.