Skip to content

Commit

Permalink
End doc sentences in a consistent way
Browse files Browse the repository at this point in the history 
During the doc review for resources we decided to go with the convention
of ending sentences with full-stop. This patch takes care of few missing
places.

Close-bug: #1226841

Change-Id: I18ccc6b20273d44b3378e9ffa35515976eda1b32
  • Loading branch information
@spzala
spzala committed Oct 21, 2013
1 parent daa8d6c commit bf465d2
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 45 deletions.
26 changes: 13 additions & 13 deletions heat/engine/resources/ceilometer/alarm.py
View file
Expand Up @@ -26,57 +26,57 @@ class CeilometerAlarm(resource.Resource):
'Required': True,
'AllowedValues': ['ge', 'gt', 'eq', 'ne', 'lt', 'le'],
'Description': _('Operator used to compare specified statistic '
'with threshold')
'with threshold.')
},
'evaluation_periods': {
'Type': 'String',
'Required': True,
'Description': _('Number of periods to evaluate over')
'Description': _('Number of periods to evaluate over.')
},
'meter_name': {
'Type': 'String',
'Required': True,
'Description': _('Meter name watched by the alarm')
'Description': _('Meter name watched by the alarm.')
},
'period': {
'Type': 'String',
'Required': True,
'Description': _('Period (seconds) to evaluate over')
'Description': _('Period (seconds) to evaluate over.')
},
'statistic': {
'Type': 'String',
'Required': True,
'AllowedValues': ['count', 'avg', 'sum', 'min', 'max'],
'Description': _('Meter statistic to evaluate')
'Description': _('Meter statistic to evaluate.')
},
'threshold': {
'Type': 'String',
'Required': True,
'Description': _('Threshold to evaluate against')
'Description': _('Threshold to evaluate against.')
},
'alarm_actions': {
'Type': 'List',
'Description': _('A list of URLs (webhooks) to invoke when state '
'transitions to alarm')
'transitions to alarm.')
},
'ok_actions': {
'Type': 'List',
'Description': _('A list of URLs (webhooks) to invoke when state '
'transitions to ok')
'transitions to ok.')
},
'insufficient_data_actions': {
'Type': 'List',
'Description': _('A list of URLs (webhooks) to invoke when state '
'transitions to insufficient-data')
'transitions to insufficient-data.')
},
'description': {
'Type': 'String',
'Description': _('Description for the alarm')
'Description': _('Description for the alarm.')
},
'enabled': {
'Type': 'Boolean',
'Default': 'true',
'Description': _('True if alarm evaluation/actioning is enabled')
'Description': _('True if alarm evaluation/actioning is enabled.')
},
'repeat_actions': {
'Type': 'Boolean',
Expand All @@ -85,12 +85,12 @@ class CeilometerAlarm(resource.Resource):
'is reached. '
'By default, actions are called when : '
'the threshold is reached AND the alarm\'s state '
'have changed')
'have changed.')
},
'matching_metadata': {
'Type': 'Map',
'Description': _('Meter should match this resource metadata '
'(key=value) additionally to the meter_name')
'(key=value) additionally to the meter_name.')
}
}

Expand Down
2 changes: 1 addition & 1 deletion heat/engine/resources/neutron/port.py
View file
Expand Up @@ -52,7 +52,7 @@ class Port(neutron.NeutronResource):
"network_id": _("Unique identifier for the network owning the port."),
"security_groups": _("A list of security groups for the port."),
"status": _("The status of the port."),
"tenant_id": _("Tenant owning the port"),
"tenant_id": _("Tenant owning the port."),
"show": _("All attributes."),
}

Expand Down
62 changes: 31 additions & 31 deletions heat/engine/resources/server.py
View file
Expand Up @@ -36,87 +36,86 @@ class Server(resource.Resource):
'Required': True,
'Description': _('A device name where the volume will be '
'attached in the system at /dev/device_name. '
'This value is typically vda')},
'This value is typically vda.')},
'volume_id': {
'Type': 'String',
'Description': _('The ID of the volume to boot from. Only one of '
'volume_id or snapshot_id should be provided')},
'volume_id or snapshot_id should be provided.')},
'snapshot_id': {
'Type': 'String',
'Description': _('The ID of the snapshot to create a volume '
'from')},
'from.')},
'volume_size': {
'Type': 'String',
'Description': _('The size of the volume, in GB. It is safe to '
'leave this blank and have the Compute service '
'infer the size')},
'infer the size.')},
'delete_on_termination': {
'Type': 'Boolean',
'Description': _('Indicate whether the volume should be deleted '
'when the server is terminated')}
'when the server is terminated.')}
}

networks_schema = {
'uuid': {
'Type': 'String',
'Description': _('ID of network to create a port on')},
'Description': _('ID of network to create a port on.')},
'fixed_ip': {
'Type': 'String',
'Description': _('Fixed IP address to specify for the port '
'created on the requested network')},
'created on the requested network.')},
'port': {
'Type': 'String',
'Description': _('ID of an existing port to associate with '
'this server')},
'this server.')},
}

properties_schema = {
'name': {
'Type': 'String',
'Description': _('Optional server name')},
'Description': _('Optional server name.')},
'image': {
'Type': 'String',
'Description': _('The ID or name of the image to boot with')},
'Description': _('The ID or name of the image to boot with.')},
'block_device_mapping': {
'Type': 'List',
'Description': _('Block device mappings for this server'),
'Description': _('Block device mappings for this server.'),
'Schema': {
'Type': 'Map',
'Schema': block_mapping_schema
}
},
'flavor': {
'Type': 'String',
'Description': _('The ID or name of the flavor to boot onto'),
'Description': _('The ID or name of the flavor to boot onto.'),
'Required': True},
'flavor_update_policy': {
'Type': 'String',
'Description': _('Policy on how to apply a flavor update; either '
'by requesting a server resize or by replacing '
'the entire server'),
'the entire server.'),
'Default': 'RESIZE',
'AllowedValues': ['RESIZE', 'REPLACE']},
'key_name': {
'Type': 'String',
'Description': _('Name of keypair to inject into the server')},
'Description': _('Name of keypair to inject into the server.')},
'admin_user': {
'Type': 'String',
'Default': cfg.CONF.instance_user,
'Description': _('Name of the administrative user to use '
' on the server')},

'on the server.')},
'availability_zone': {
'Type': 'String',
'Description': _('Name of the availability zone for server '
'placement')},
'placement.')},
'security_groups': {
'Type': 'List',
'Description': _('List of security group names')},
'Description': _('List of security group names.')},
'networks': {
'Type': 'List',
'Description': _('An ordered list of nics to be '
'added to this server, with information about '
'connected networks, fixed ips, port etc'),
'connected networks, fixed ips, port etc.'),
'Schema': {
'Type': 'Map',
'Schema': networks_schema
Expand All @@ -125,51 +124,52 @@ class Server(resource.Resource):
'scheduler_hints': {
'Type': 'Map',
'Description': _('Arbitrary key-value pairs specified by the '
'client to help boot a server')},
'client to help boot a server.')},
'metadata': {
'Type': 'Map',
'Description': _('Arbitrary key/value metadata to store for this '
'server. A maximum of five entries is allowed, '
'and both keys and values must be 255 characters '
'or less')},
'or less.')},
'user_data': {
'Type': 'String',
'Description': _('User data script to be executed by cloud-init')},
'Description': _('User data script to be executed by '
'cloud-init.')},
'reservation_id': {
'Type': 'String',
'Description': _('A UUID for the set of servers being requested')
'Description': _('A UUID for the set of servers being requested.')
},
'config_drive': {
'Type': 'String',
'Description': _('value for config drive either boolean, or '
'volume-id')
'volume-id.')
},
# diskConfig translates to API attribute OS-DCF:diskConfig
# hence the camel case instead of underscore to separate the words
'diskConfig': {
'Type': 'String',
'Description': _('Control how the disk is partitioned when the '
'server is created'),
'server is created.'),
'AllowedValues': ['AUTO', 'MANUAL']}
}

attributes_schema = {
'show': _('A dict of all server details as returned by the API'),
'show': _('A dict of all server details as returned by the API.'),
'addresses': _('A dict of all network addresses as returned by '
'the API'),
'the API.'),
'networks': _('A dict of assigned network addresses of the form: '
'{"public": [ip1, ip2...], "private": [ip3, ip4]}'),
'{"public": [ip1, ip2...], "private": [ip3, ip4]}.'),
'first_address': _('Convenience attribute to fetch the first '
'assigned network address, or an '
'empty string if nothing has been assigned '
'at this time. Result may not be predictable '
'if the server has addresses from more than one '
'network.'),
'instance_name': _('AWS compatible instance name'),
'instance_name': _('AWS compatible instance name.'),
'accessIPv4': _('The manually assigned alternative public IPv4 '
'address of the server'),
'address of the server.'),
'accessIPv6': _('The manually assigned alternative public IPv6 '
'address of the server'),
'address of the server.'),
}

update_allowed_keys = ('Metadata', 'Properties')
Expand Down

0 comments on commit bf465d2

Please sign in to comment.