openstack/heat
Code Issues Proposed changes

Do not use suppport message if it's None

Browse Source 
'message' attribute of SupportStatus class has default value equal None.
If you use support_status value in Schema class without providing
'message', you will get in documentation warning in form: DEPRECATED - None.
It looks confused and in such case we should display only 'status'
attribute: DEPRECATED.

Change-Id: I482fe6a9ca134e9e3bc54282b4b10ed98c29b028
This commit is contained in:
Sergey Kraynev
2014-04-14 03:49:11 -04:00
parent 3a61debdec
commit 8c3a9e4ce2
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/ext/resources.py
View File

@@ -53,8 +53,10 @@ class ResourcePages(Directive):
if resource_class.support_status.status == support.DEPRECATED:
sstatus = resource_class.support_status.to_dict()
para = nodes.inline(
'', _('%(status)s - %(message)s') % sstatus)
msg = _('%(status)s')
if sstatus['message'] is not None:
msg = _('%(status)s - %(message)s')
para = nodes.inline('', msg % sstatus)
warning = nodes.note('', para)
section.append(warning)
@@ -191,9 +193,11 @@ Resources:
prop_item.append(definition)
if prop.support_status.status != support.SUPPORTED:
para = nodes.inline(
'',
_('%(status)s - %(message)s') % prop.support_status.to_dict())
sstatus = prop.support_status.to_dict()
msg = _('%(status)s')
if sstatus['message'] is not None:
msg = _('%(status)s - %(message)s')
para = nodes.inline('', msg % sstatus)
warning = nodes.note('', para)
definition.append(warning)