openstack
/
deb-tempest
Code Issues Proposed changes

[DOC BLD FIX] Correct reST field lists in docstrings 

Most common format for documenting arguments is reST field, the incorrect
docstring will cause a Sphinx warning to be generated and caused the documentation
to be improperly rendered.

[1] http://sphinx-doc.org/domains.html#info-field-lists

Change-Id: I031cc3ca202b140b6ff6d9fadc46e0765ee2f36c
This commit is contained in:
junboli 2017-07-21 13:24:38 +08:00
parent d3fa46495a
commit 872ca87550
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tempest/lib/common/rest_client.py
View File

@ -371,7 +371,7 @@ class RestClient(object):
on the endpoint in the catalog will return a list of supported API
versions.
:return tuple with response headers and list of version numbers
:return: tuple with response headers and list of version numbers
:rtype: tuple
"""
resp, body = self.get('')

2
tempest/lib/services/clients.py
View File

@ -161,7 +161,7 @@ class ClientsFactory(object):
:param kwargs: Parameters to be passed to all clients. Parameters
values can be overwritten when clients are initialised, but
parameters cannot be deleted.
:raise ImportError if the specified module_path cannot be imported
:raise ImportError: if the specified module_path cannot be imported
Example::