openstack/heat
Code Issues Proposed changes

Merge "Improved the descriptions of funtion parameters."

Browse Source
This commit is contained in:
Jenkins 2017-02-20 00:45:20 +00:00 committed by Gerrit Code Review
commit c11a736ef7
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

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

36
heat/rpc/client.py
View File

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