openstack/heat
Code Issues Proposed changes

Remove warnings when generating docs

Browse Source 
Improve docstrings so that syntax warnings are no longer displayed when
generating docs.

Related-Bug: 1403897
Change-Id: I0163bc7f83e00f9077fc78e638173df2124580dd
This commit is contained in:
Anderson Mesquita 2014-12-16 14:39:37 -08:00
parent 88853d5d9d
commit c762782284
3 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/template_guide/hot_spec.rst
View File

@ -890,6 +890,6 @@ provided parameter. The script for doing this is provided as userdata to the
compute instance, leveraging the str_replace function.
Fn::Select
---------
----------
*Fn::Select* is a function borrowed from CFN template. Please check the CFN
template guide for a description.

15
heat/engine/properties.py
View File

@ -481,16 +481,13 @@ class Properties(collections.Mapping):
:param schema: A resource type's properties_schema
:returns: A tuple of params and properties dicts
ex: input: {'foo': {'Type': 'String'}}
output: {'foo': {'Type': 'String'}},
{'foo': {'Ref': 'foo'}}
ex: input: {'foo': {'Type': 'List'}, 'bar': {'Type': 'Map'}}
output: {'foo': {'Type': 'CommaDelimitedList'}
'bar': {'Type': 'Json'}},
{'foo': {'Fn::Split': {'Ref': 'foo'}},
'bar': {'Ref': 'bar'}}
ex: input: {'foo': {'Type': 'List'}}
output: {'foo': {'Type': 'CommaDelimitedList'}},
{'foo': {'Fn::Split': {'Ref': 'foo'}}}
ex: input: {'foo': {'Type': 'String'}, 'bar': {'Type': 'Map'}}
output: {'foo': {'Type': 'String'}, 'bar': {'Type': 'Json'}},
{'foo': {'Ref': 'foo'}, 'bar': {'Ref': 'bar'}}
"""
def param_prop_def_items(name, schema):
param_def = cls._param_def_from_prop(schema)

4
heat/engine/stack_resource.py
View File

@ -76,8 +76,8 @@ class StackResource(resource.Resource):
return True
def nested(self, force_reload=False, show_deleted=False):
'''
Return a Stack object representing the nested (child) stack.
'''Return a Stack object representing the nested (child) stack.
:param force_reload: Forces reloading from the DB instead of returning
the locally cached Stack object
:param show_deleted: Returns the stack even if it's been deleted