openstack/ceilometer
Code Issues Proposed changes

Fix some reST field lists in docstrings

Browse Source 
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: I4ee986224549f1b243c81c71e287ad95105e8cb9
This commit is contained in:
XieYingYun 2017-03-25 16:13:12 +08:00 committed by gordon chung
parent a868016635
commit e082b08082
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ceilometer/hardware/inspector/base.py
View File

@ -29,10 +29,9 @@ class Inspector(object):
:param cache: cache passed from the pollster :param cache: cache passed from the pollster
:param extra_metadata: extra dict to be used as metadata :param extra_metadata: extra dict to be used as metadata
:param param: a dict of inspector specific param :param param: a dict of inspector specific param
:return: an iterator of (value, metadata, extra) :return: an iterator of (value, metadata, extra) containing the sample
:return value: the sample value value, metadata dict to construct sample's metadata, and
:return metadata: dict to construct sample's metadata extra dict of extra metadata to help constructing sample
:return extra: dict of extra metadata to help constructing sample
""" """
def prepare_params(self, param): def prepare_params(self, param):

2
ceilometer/hardware/pollsters/generic.py
View File

@ -84,7 +84,7 @@ class GenericHardwareDeclarativePollster(plugin_base.PollsterBase):
as metadata. as metadata.
:param res: URL or dict containing all resource info. :param res: URL or dict containing all resource info.
:return parsed_url, resource_id, metadata: Returns parsed URL used for :return: parsed_url, resource_id, metadata Returns parsed URL used for
SNMP query, unique identifier of the resource and metadata SNMP query, unique identifier of the resource and metadata
of the resource. of the resource.
""" """