openstack
/
heat
Code Issues Proposed changes

Improved the descriptions of funtion parameters. 

Change-Id: I2557abe296d0ef0a0ed80f3a178c91566dbc3654
Closes-Bug: #1630234
This commit is contained in:
abdul nizamuddin 2016-10-04 22:43:15 +05:30
parent 80b2fb3155
commit 43752000aa
2 changed files with 40 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
heat/engine/service.py
View File

@ -547,14 +547,16 @@ class EngineService(service.Service):
:param show_deleted: if true, show soft-deleted stacks
:param show_nested: if true, show nested stacks
:param show_hidden: if true, show hidden stacks
:param tags: show stacks containing these tags, combine multiple
tags using the boolean AND expression
:param tags_any: show stacks containing these tags, combine multiple
tags using the boolean OR expression
:param not_tags: show stacks not containing these tags, combine
multiple tags using the boolean AND expression
:param not_tags_any: show stacks not containing these tags, combine
multiple tags using the boolean OR expression
:param tags: show stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean AND expression
:param tags_any: show stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean OR expression
:param not_tags: show stacks not containing these tags. If multiple
tags are passed, they will be combined using the boolean AND
expression
:param not_tags_any: show stacks not containing these tags. If
multiple tags are passed, they will be combined using the boolean
OR expression
:returns: a list of formatted stacks
"""
if filters is not None:
@ -593,14 +595,16 @@ class EngineService(service.Service):
:param show_deleted: if true, count will include the deleted stacks
:param show_nested: if true, count will include nested stacks
:param show_hidden: if true, count will include hidden stacks
:param tags: count stacks containing these tags, combine multiple tags
using the boolean AND expression
:param tags_any: count stacks containing these tags, combine multiple
tags using the boolean OR expression
:param not_tags: count stacks not containing these tags, combine
multiple tags using the boolean AND expression
:param not_tags_any: count stacks not containing these tags, combine
multiple tags using the boolean OR expression
:param tags: count stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean AND expression
:param tags_any: count stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean OR expression
:param not_tags: count stacks not containing these tags. If multiple
tags are passed, they will be combined using the boolean AND
expression
:param not_tags_any: count stacks not containing these tags. If
multiple tags are passed, they will be combined using the boolean
OR expression
:returns: an integer representing the number of matched stacks
"""
if not tenant_safe:

36
heat/rpc/client.py
View File

@ -138,14 +138,16 @@ class EngineClient(object):
:param show_deleted: if true, show soft-deleted stacks
:param show_nested: if true, show nested stacks
:param show_hidden: if true, show hidden stacks
:param tags: show stacks containing these tags, combine multiple
tags using the boolean AND expression
:param tags_any: show stacks containing these tags, combine multiple
tags using the boolean OR expression
:param not_tags: show stacks not containing these tags, combine
multiple tags using the boolean AND expression
:param not_tags_any: show stacks not containing these tags, combine
multiple tags using the boolean OR expression
:param tags: show stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean AND expression
:param tags_any: show stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean OR expression
:param not_tags: show stacks not containing these tags. If multiple
tags are passed, they will be combined using the boolean AND
expression
:param not_tags_any: show stacks not containing these tags. If
multiple tags are passed, they will be combined using the boolean
OR expression
:returns: a list of stacks
"""
return self.call(ctxt,
@ -171,14 +173,16 @@ class EngineClient(object):
:param show_deleted: if true, count will include the deleted stacks
:param show_nested: if true, count will include nested stacks
:param show_hidden: if true, count will include hidden stacks
:param tags: count stacks containing these tags, combine multiple tags
using the boolean AND expression
:param tags_any: count stacks containing these tags, combine multiple
tags using the boolean OR expression
:param not_tags: count stacks not containing these tags, combine
multiple tags using the boolean AND expression
:param not_tags_any: count stacks not containing these tags, combine
multiple tags using the boolean OR expression
:param tags: count stacks containing these tags. If multiple tags are
passed, they will be combined using the boolean AND expression
:param tags_any: count stacks containing these tags. If multiple tags
are passed, they will be combined using the boolean OR expression
:param not_tags: count stacks not containing these tags. If multiple
tags are passed, they will be combined using the boolean AND
expression
:param not_tags_any: count stacks not containing these tags. If
multiple tags are passed, they will be combined using the boolean
OR expression
:returns: an integer representing the number of matched stacks
"""
return self.call(ctxt, self.make_msg('count_stacks',