From 622bb9a702617e4754784a04de66a21c9e2a4e1a Mon Sep 17 00:00:00 2001
From: Ian Main <imain@redhat.com>
Date: Thu, 22 Mar 2012 17:37:17 -0700
Subject: [PATCH] A few cleanups and some comments.  Nothing major.

Signed-off-by: Ian Main <imain@redhat.com>
---
 bin/heat        | 7 ++++---
 bin/heat-api    | 4 +++-
 bin/heat-engine | 4 +++-
 heat/client.py  | 4 ++--
 4 files changed, 12 insertions(+), 7 deletions(-)

diff --git a/bin/heat b/bin/heat
index b7185686..6c90ee8a 100755
--- a/bin/heat
+++ b/bin/heat
@@ -19,7 +19,8 @@
 """
 This is the administration program for heat. It is simply a command-line
 interface for adding, modifying, and retrieving information about the stacks
-belonging to a user.
+belonging to a user.  It is a convenience application that talks to the heat
+API server.
 """
 
 import functools
@@ -107,7 +108,7 @@ def stack_create(options, arguments):
         return FAILURE
 
     if options.parameters:
-        count=1
+        count = 1
         for p in options.parameters.split(';'):
             (n, v) = p.split('=')
             parameters['Parameters.member.%d.ParameterKey' % count] = n
@@ -144,7 +145,7 @@ def stack_update(options, arguments):
         parameters['TemplateUrl'] = options.template_url
 
     if options.parameters:
-        count=1
+        count = 1
         for p in options.parameters.split(';'):
             (n, v) = p.split('=')
             parameters['Parameters.member.%d.ParameterKey' % count] = n
diff --git a/bin/heat-api b/bin/heat-api
index 8917308c..611b53b4 100755
--- a/bin/heat-api
+++ b/bin/heat-api
@@ -19,7 +19,9 @@
 #    under the License.
 
 """
-Heat API Server
+Heat API Server.  This implements an approximation of the Amazon
+CloudFormations API and translates it into a native representation.  It then
+calls the heat-engine via REST to implement them.
 """
 
 import gettext
diff --git a/bin/heat-engine b/bin/heat-engine
index d162bf27..df0176b5 100755
--- a/bin/heat-engine
+++ b/bin/heat-engine
@@ -15,7 +15,9 @@
 #    under the License.
 
 """
-Heat Engine Server
+Heat Engine Server.  This does the work of actually implementing the API
+calls made by the user.  Normal communications is done via the heat API
+which then calls into this engine.
 """
 
 import gettext
diff --git a/heat/client.py b/heat/client.py
index fb5e5218..d0cd6dc1 100644
--- a/heat/client.py
+++ b/heat/client.py
@@ -88,7 +88,7 @@ class V1Client(base_client.BaseClient):
         data = json.loads(res.read())
         return data
 
-Client = V1Client
+HeatClient = V1Client
 
 
 def get_client(host, port=None, username=None,
@@ -128,7 +128,7 @@ def get_client(host, port=None, username=None,
     use_ssl = (creds['auth_url'] is not None and
         creds['auth_url'].find('https') != -1)
 
-    client = Client
+    client = HeatClient
 
     return client(host=host,
                 port=port,
-- 
2.45.2