From cb579cd71aac79ea7bfa7a2cd4f9d76ae43b1f15 Mon Sep 17 00:00:00 2001
From: Steve Baker <sbaker@redhat.com>
Date: Wed, 20 Apr 2016 09:15:18 +1200
Subject: [PATCH] Document create_stack

Change-Id: Ie79f513cb53be60130ce4dabff73e0463b4e1ebb
---
 shade/openstackcloud.py | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/shade/openstackcloud.py b/shade/openstackcloud.py
index 02c0ecff4..d7f6e6e76 100644
--- a/shade/openstackcloud.py
+++ b/shade/openstackcloud.py
@@ -853,6 +853,29 @@ class OpenStackCloud(object):
             wait=False, timeout=3600,
             environment_files=None,
             **parameters):
+        """Create a Heat Stack.
+
+        :param string name: Name of the stack.
+        :param string template_file: Path to the template.
+        :param string template_url: URL of template.
+        :param string template_object: URL to retrieve template object.
+        :param dict files: dict of additional file content to include.
+        :param boolean rollback: Enable rollback on create failure.
+        :param boolean wait: Whether to wait for the delete to finish.
+        :param int timeout: Stack create timeout in seconds.
+        :param list environment_files: Paths to environment files to apply.
+
+        Other arguments will be passed as stack parameters which will take
+        precedence over any parameters specified in the environments.
+
+        Only one of template_file, template_url, template_object should be
+        specified.
+
+        :returns: a dict containing the stack description
+
+        :raises: ``OpenStackCloudException`` if something goes wrong during
+            the openstack API call
+        """
         envfiles, env = template_utils.process_multiple_environments_and_files(
             env_paths=environment_files)
         tpl_files, template = template_utils.get_template_contents(