From e082b08082683af6f1f494da17af91fee37f1ca6 Mon Sep 17 00:00:00 2001
From: XieYingYun <smokony@sina.com>
Date: Sat, 25 Mar 2017 16:13:12 +0800
Subject: [PATCH] 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: I4ee986224549f1b243c81c71e287ad95105e8cb9
---
 ceilometer/hardware/inspector/base.py    | 7 +++----
 ceilometer/hardware/pollsters/generic.py | 2 +-
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/ceilometer/hardware/inspector/base.py b/ceilometer/hardware/inspector/base.py
index 1dc3ce0684..d8c1ae7f71 100644
--- a/ceilometer/hardware/inspector/base.py
+++ b/ceilometer/hardware/inspector/base.py
@@ -29,10 +29,9 @@ class Inspector(object):
         :param cache: cache passed from the pollster
         :param extra_metadata: extra dict to be used as metadata
         :param param: a dict of inspector specific param
-        :return: an iterator of (value, metadata, extra)
-        :return value: the sample value
-        :return metadata: dict to construct sample's metadata
-        :return extra: dict of extra metadata to help constructing sample
+        :return: an iterator of (value, metadata, extra) containing the sample
+                 value, metadata dict to construct sample's metadata, and
+                 extra dict of extra metadata to help constructing sample
         """
 
     def prepare_params(self, param):
diff --git a/ceilometer/hardware/pollsters/generic.py b/ceilometer/hardware/pollsters/generic.py
index 647cfca1d3..6c8b5d5197 100644
--- a/ceilometer/hardware/pollsters/generic.py
+++ b/ceilometer/hardware/pollsters/generic.py
@@ -84,7 +84,7 @@ class GenericHardwareDeclarativePollster(plugin_base.PollsterBase):
         as metadata.
 
         :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
             of the resource.
         """