From 30cfabfa9a5897a2c95fcbf483e046cf2c793b44 Mon Sep 17 00:00:00 2001
From: liu-sheng <liusheng@huawei.com>
Date: Thu, 13 Feb 2014 17:59:51 +0800
Subject: [PATCH] Fix some flaws in ceilometer docstrings

Change-Id: Iaed56b46cefff10f9a88fa5096390b19a297d237
---
 ceilometer/api/controllers/v2.py      |  2 +-
 ceilometer/compute/nova_notifier.py   |  2 +-
 ceilometer/pipeline.py                | 10 +++++-----
 ceilometer/storage/impl_sqlalchemy.py |  4 +++-
 4 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/ceilometer/api/controllers/v2.py b/ceilometer/api/controllers/v2.py
index 76dbd318d..9c596f939 100644
--- a/ceilometer/api/controllers/v2.py
+++ b/ceilometer/api/controllers/v2.py
@@ -646,7 +646,7 @@ class Statistics(_Base):
         # "invalid."
         #
         # If the timestamps are invalid, return None as a
-        # sentinal indicating that there is something "funny"
+        # sentinel indicating that there is something "funny"
         # about the range.
         if (self.duration_start and
                 self.duration_end and
diff --git a/ceilometer/compute/nova_notifier.py b/ceilometer/compute/nova_notifier.py
index f4f048204..b240e766e 100644
--- a/ceilometer/compute/nova_notifier.py
+++ b/ceilometer/compute/nova_notifier.py
@@ -96,7 +96,7 @@ class Instance(object):
 
     The pollsters all expect an instance that looks like what the
     novaclient gives them, but the conductor API gives us a
-    dictionary. This class makes an object from the dictonary so we
+    dictionary. This class makes an object from the dictionary so we
     can pass it to the pollsters.
     """
     def __init__(self, context, info):
diff --git a/ceilometer/pipeline.py b/ceilometer/pipeline.py
index 59058bf2d..2dc454cf5 100644
--- a/ceilometer/pipeline.py
+++ b/ceilometer/pipeline.py
@@ -75,7 +75,7 @@ class Pipeline(object):
     """Sample handling pipeline
 
     Pipeline describes a chain of handlers. The chain starts with
-    tranformer and ends with one or more publishers.
+    transformer and ends with one or more publishers.
 
     The first transformer in the chain gets sample from data collector, i.e.
     pollster or notification handler, takes some action like dropping,
@@ -313,13 +313,13 @@ class PipelineManager(object):
         The top of the cfg is a list of pipeline definitions.
 
         Pipeline definition is an dictionary specifying the target samples,
-        the tranformers involved, and the target publishers:
+        the transformers involved, and the target publishers:
         {
             "name": pipeline_name
             "interval": interval_time
             "meters" :  ["meter_1", "meter_2"],
             "resources": ["resource_uri1", "resource_uri2"],
-            "tranformers":[
+            "transformers":[
                               {"name": "Transformer_1",
                                "parameters": {"p1": "value"}},
 
@@ -348,9 +348,9 @@ class PipelineManager(object):
         the meters should be polled. It's optional and it's up to the
         specific pollster to decide how to use it.
 
-        Transformer's name is plugin name in setup.py.
+        Transformer's name is plugin name in setup.cfg.
 
-        Publisher's name is plugin name in setup.py
+        Publisher's name is plugin name in setup.cfg
 
         """
         self.pipelines = [Pipeline(pipedef, transformer_manager)
diff --git a/ceilometer/storage/impl_sqlalchemy.py b/ceilometer/storage/impl_sqlalchemy.py
index 29074fe22..6d9fa0805 100644
--- a/ceilometer/storage/impl_sqlalchemy.py
+++ b/ceilometer/storage/impl_sqlalchemy.py
@@ -130,7 +130,9 @@ def apply_metaquery_filter(session, query, metaquery):
 def make_query_from_filter(session, query, sample_filter, require_meter=True):
     """Return a query dictionary based on the settings in the filter.
 
-    :param filter: SampleFilter instance
+    :param session: session used for original query
+    :param query: Query instance
+    :param sample_filter: SampleFilter instance
     :param require_meter: If true and the filter does not have a meter,
                           raise an error.
     """