openstack/aodh
Code Issues Proposed changes

Fix some reST field lists in docstrings

Browse Source 
remove the redundant ":"

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: I6c8eaa3295c04463aea291fc3182060fe2b66ec3
This commit is contained in:
rtmdk 2017-03-24 23:51:37 -07:00
parent 62b819152b
commit ecc660ba05
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
aodh/api/controllers/v2/utils.py
View File

@ -106,7 +106,7 @@ def validate_query(query, db_func, internal_keys=None,
:raises InvalidInput: if an operator is not supported for a given field
:raises InvalidInput: if timestamp constraints are allowed, but
search_offset was included without timestamp constraint
:raises: UnknownArgument: if a field name is not a timestamp field, nor
:raises UnknownArgument: if a field name is not a timestamp field, nor
in the list of valid keys
"""