From 59103984bb53fd1535e186369e766e9e13cb1337 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Sun, 6 Jul 2014 20:55:22 +0200 Subject: [PATCH] Replaced 'e.g.' with 'for example' According to the IBM Style Guide the Latin abbreviation 'e.g.' should be replace by 'for example'. Change-Id: I694df5ed62213e29bdf35f781fd6f310b7df77a6 --- oslo/messaging/_drivers/impl_qpid.py | 2 +- oslo/messaging/conffixture.py | 2 +- oslo/messaging/notify/listener.py | 3 ++- oslo/messaging/notify/notifier.py | 27 ++++++++++++++++++--------- oslo/messaging/rpc/server.py | 3 ++- oslo/messaging/server.py | 3 ++- oslo/messaging/transport.py | 6 +++--- 7 files changed, 29 insertions(+), 17 deletions(-) diff --git a/oslo/messaging/_drivers/impl_qpid.py b/oslo/messaging/_drivers/impl_qpid.py index 7852cb216..a7e231f63 100644 --- a/oslo/messaging/_drivers/impl_qpid.py +++ b/oslo/messaging/_drivers/impl_qpid.py @@ -680,7 +680,7 @@ class Connection(object): def topic_send(self, exchange_name, topic, msg, timeout=None, retry=None): """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 # so let's create an actual Qpid message here and get some # value-add on the go. diff --git a/oslo/messaging/conffixture.py b/oslo/messaging/conffixture.py index 758db24be..4838fd879 100644 --- a/oslo/messaging/conffixture.py +++ b/oslo/messaging/conffixture.py @@ -61,7 +61,7 @@ class ConfFixture(fixtures.Fixture): @property 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 @transport_driver.setter diff --git a/oslo/messaging/notify/listener.py b/oslo/messaging/notify/listener.py index 9d86d80b5..feaf90e66 100644 --- a/oslo/messaging/notify/listener.py +++ b/oslo/messaging/notify/listener.py @@ -110,7 +110,8 @@ def get_notification_listener(transport, targets, endpoints, :type targets: list of Target :param endpoints: a list of endpoint objects :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 :param serializer: an optional entity serializer :type serializer: Serializer diff --git a/oslo/messaging/notify/notifier.py b/oslo/messaging/notify/notifier.py index 783ba3975..e15a8008e 100644 --- a/oslo/messaging/notify/notifier.py +++ b/oslo/messaging/notify/notifier.py @@ -101,7 +101,8 @@ class Notifier(object): :param transport: the transport to use for sending messages :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 :param driver: a driver to lookup from oslo.messaging.notify.drivers :type driver: str @@ -148,7 +149,8 @@ class Notifier(object): sending notifications from multiple publisher_ids without the overhead 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 :param retry: an connection retries configuration None or -1 means to retry forever @@ -186,7 +188,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -199,7 +202,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -212,7 +216,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -225,7 +230,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -240,7 +246,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -253,7 +260,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict @@ -272,7 +280,8 @@ class Notifier(object): :param ctxt: a request context 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 :param payload: the notification payload :type payload: dict diff --git a/oslo/messaging/rpc/server.py b/oslo/messaging/rpc/server.py index 03ff4b6bd..9a0783a44 100644 --- a/oslo/messaging/rpc/server.py +++ b/oslo/messaging/rpc/server.py @@ -111,7 +111,8 @@ def get_rpc_server(transport, target, endpoints, :type target: Target :param endpoints: a list of endpoint objects :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 :param serializer: an optional entity serializer :type serializer: Serializer diff --git a/oslo/messaging/server.py b/oslo/messaging/server.py index 09cdf0fbf..9d354e4b6 100644 --- a/oslo/messaging/server.py +++ b/oslo/messaging/server.py @@ -75,7 +75,8 @@ class MessageHandlingServer(object): :type transport: Transport :param dispatcher: a callable which is invoked for each method :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 """ self.conf = transport.conf diff --git a/oslo/messaging/transport.py b/oslo/messaging/transport.py index f33bdc8d0..e1a421064 100644 --- a/oslo/messaging/transport.py +++ b/oslo/messaging/transport.py @@ -231,9 +231,9 @@ class TransportURL(object): :param conf: a ConfigOpts instance :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 - :param virtual_host: a virtual host path e.g. '/' + :param virtual_host: a virtual host path for example '/' :type virtual_host: str :param hosts: a list of TransportHost objects :type hosts: list @@ -378,7 +378,7 @@ class TransportURL(object): url = parse.urlparse(url) # 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 if '?' in url.path or url.query: raise InvalidTransportURL(url.geturl(),