openstack
/
oslo.messaging
Code Issues Proposed changes

Merge "Replaced 'e.g.' with 'for example'"

This commit is contained in:
Jenkins 2014-07-08 14:59:13 +00:00 committed by Gerrit Code Review
parent 71588adbb5 59103984bb
commit 67e4cc1194
7 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
oslo/messaging/_drivers/impl_qpid.py
View File

@ -680,7 +680,7 @@ class Connection(object):
def topic_send(self, exchange_name, topic, msg, timeout=None, retry=None): def topic_send(self, exchange_name, topic, msg, timeout=None, retry=None):
"""Send a 'topic' message.""" """Send a 'topic' message."""
# #
# We want to create a message with attributes, e.g. a TTL. We # We want to create a message with attributes, for example a TTL. We
# don't really need to keep 'msg' in its JSON format any longer # don't really need to keep 'msg' in its JSON format any longer
# so let's create an actual Qpid message here and get some # so let's create an actual Qpid message here and get some
# value-add on the go. # value-add on the go.

2
oslo/messaging/conffixture.py
View File

@ -61,7 +61,7 @@ class ConfFixture(fixtures.Fixture):
@property @property
def transport_driver(self): def transport_driver(self):
"""The transport driver - e.g. 'rabbit', 'qpid' or 'fake'.""" """The transport driver - for example 'rabbit', 'qpid' or 'fake'."""
return self.conf.rpc_backend return self.conf.rpc_backend
@transport_driver.setter @transport_driver.setter

3
oslo/messaging/notify/listener.py
View File

@ -110,7 +110,8 @@ def get_notification_listener(transport, targets, endpoints,
:type targets: list of Target :type targets: list of Target
:param endpoints: a list of endpoint objects :param endpoints: a list of endpoint objects
:type endpoints: list :type endpoints: list
:param executor: name of a message executor - e.g. 'eventlet', 'blocking' :param executor: name of a message executor - for example
'eventlet', 'blocking'
:type executor: str :type executor: str
:param serializer: an optional entity serializer :param serializer: an optional entity serializer
:type serializer: Serializer :type serializer: Serializer

27
oslo/messaging/notify/notifier.py
View File

@ -101,7 +101,8 @@ class Notifier(object):
:param transport: the transport to use for sending messages :param transport: the transport to use for sending messages
:type transport: oslo.messaging.Transport :type transport: oslo.messaging.Transport
:param publisher_id: field in notifications sent, e.g. 'compute.host1' :param publisher_id: field in notifications sent, for example
'compute.host1'
:type publisher_id: str :type publisher_id: str
:param driver: a driver to lookup from oslo.messaging.notify.drivers :param driver: a driver to lookup from oslo.messaging.notify.drivers
:type driver: str :type driver: str
@ -148,7 +149,8 @@ class Notifier(object):
sending notifications from multiple publisher_ids without the overhead sending notifications from multiple publisher_ids without the overhead
of notification driver loading. of notification driver loading.
:param publisher_id: field in notifications sent, e.g. 'compute.host1' :param publisher_id: field in notifications sent, for example
'compute.host1'
:type publisher_id: str :type publisher_id: str
:param retry: an connection retries configuration :param retry: an connection retries configuration
None or -1 means to retry forever None or -1 means to retry forever
@ -186,7 +188,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -199,7 +202,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -212,7 +216,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -225,7 +230,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -240,7 +246,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -253,7 +260,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict
@ -272,7 +280,8 @@ class Notifier(object):
:param ctxt: a request context dict :param ctxt: a request context dict
:type ctxt: dict :type ctxt: dict
:param event_type: describes the event, e.g. 'compute.create_instance' :param event_type: describes the event, for example
'compute.create_instance'
:type event_type: str :type event_type: str
:param payload: the notification payload :param payload: the notification payload
:type payload: dict :type payload: dict

3
oslo/messaging/rpc/server.py
View File

@ -111,7 +111,8 @@ def get_rpc_server(transport, target, endpoints,
:type target: Target :type target: Target
:param endpoints: a list of endpoint objects :param endpoints: a list of endpoint objects
:type endpoints: list :type endpoints: list
:param executor: name of a message executor - e.g. 'eventlet', 'blocking' :param executor: name of a message executor - for example
'eventlet', 'blocking'
:type executor: str :type executor: str
:param serializer: an optional entity serializer :param serializer: an optional entity serializer
:type serializer: Serializer :type serializer: Serializer

3
oslo/messaging/server.py
View File

@ -75,7 +75,8 @@ class MessageHandlingServer(object):
:type transport: Transport :type transport: Transport
:param dispatcher: a callable which is invoked for each method :param dispatcher: a callable which is invoked for each method
:type dispatcher: callable :type dispatcher: callable
:param executor: name of message executor - e.g. 'eventlet', 'blocking' :param executor: name of message executor - for example
'eventlet', 'blocking'
:type executor: str :type executor: str
""" """
self.conf = transport.conf self.conf = transport.conf

6
oslo/messaging/transport.py
View File

@ -231,9 +231,9 @@ class TransportURL(object):
:param conf: a ConfigOpts instance :param conf: a ConfigOpts instance
:type conf: oslo.config.cfg.ConfigOpts :type conf: oslo.config.cfg.ConfigOpts
:param transport: a transport name e.g. 'rabbit' or 'qpid' :param transport: a transport name for example 'rabbit' or 'qpid'
:type transport: str :type transport: str
:param virtual_host: a virtual host path e.g. '/' :param virtual_host: a virtual host path for example '/'
:type virtual_host: str :type virtual_host: str
:param hosts: a list of TransportHost objects :param hosts: a list of TransportHost objects
:type hosts: list :type hosts: list
@ -378,7 +378,7 @@ class TransportURL(object):
url = parse.urlparse(url) url = parse.urlparse(url)
# Make sure there's not a query string; that could identify # Make sure there's not a query string; that could identify
# requirements we can't comply with (e.g., ssl), so reject it if # requirements we can't comply with (for example ssl), so reject it if
# it's present # it's present
if '?' in url.path or url.query: if '?' in url.path or url.query:
raise InvalidTransportURL(url.geturl(), raise InvalidTransportURL(url.geturl(),