Fix some reST field lists in docstrings
Probably the most common format for documenting arguments is reST field lists [1]. This change updates some docstrings to comply with the field lists syntax. [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: I6b783d7c92852d656586e30d2456218436d1a015
This commit is contained in:
parent
b4ebcb676f
commit
21899f043c
|
@ -250,7 +250,7 @@ class AsyncJobController(rest.RestController):
|
|||
"""Return a dictionary of query param filters from the request.
|
||||
|
||||
:param params: the URI params coming from the wsgi layer
|
||||
:return (flag, filters), flag indicates whether the filters are valid,
|
||||
:return: (flag, filters), flag indicates whether the filters are valid,
|
||||
and the filters denote a list of key-value pairs.
|
||||
"""
|
||||
filters = {}
|
||||
|
|
|
@ -91,7 +91,7 @@ class RoutingController(rest.RestController):
|
|||
"""Return a dictionary of query param filters from the request.
|
||||
|
||||
:param params: the URI params coming from the wsgi layer
|
||||
:return (flag, filters), flag indicates whether the filters are valid,
|
||||
:return: (flag, filters), flag indicates whether the filters are valid,
|
||||
and the filters denote a list of key-value pairs.
|
||||
"""
|
||||
filters = {}
|
||||
|
|
Loading…
Reference in New Issue