openstack/oslo.messaging
Code Issues Proposed changes

Fix some reST field lists in docstrings

Browse Source 
Probably the most common format for documenting arguments is reST field
lists [1]. This change updates some docstrings to comply with the field
lists syntax.
[1] http://sphinx-doc.org/domains.html#info-field-lists

Change-Id: Ifa8c0db3efc03eac3b034ef642aaa8fce514a66e
This commit is contained in:
lingyongxu 2017-09-05 15:10:35 +08:00 committed by Lingyong Xu
parent ba30a3067d
commit d7229a124f
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
oslo_messaging/_drivers/pika_driver/pika_message.py
View File

@ -180,7 +180,7 @@ class RpcPikaIncomingMessage(PikaIncomingMessage, base.RpcIncomingMessage):
:param failure: Tuple, should be a sys.exc_info() tuple. :param failure: Tuple, should be a sys.exc_info() tuple.
Should be None if RPC request was successfully processed. Should be None if RPC request was successfully processed.
:return RpcReplyPikaIncomingMessage, message with reply :return RpcReplyPikaIncomingMessage: message with reply
""" """
if self.reply_q is None: if self.reply_q is None:

8
oslo_messaging/_drivers/pika_driver/pika_poller.py
View File

@ -218,7 +218,7 @@ class PikaPoller(base.Listener):
exchange and (or) queue do not exist. Should be overridden in child exchange and (or) queue do not exist. Should be overridden in child
classes classes
:return Dictionary, declared_queue_name -> no_ack_mode :return Dictionary: declared_queue_name -> no_ack_mode
""" """
raise NotImplementedError( raise NotImplementedError(
"It is base class. Please declare exchanges and queues here" "It is base class. Please declare exchanges and queues here"
@ -377,7 +377,7 @@ class RpcServicePikaPoller(PikaPoller):
"""Overrides base method and perform declaration of RabbitMQ exchanges """Overrides base method and perform declaration of RabbitMQ exchanges
and queues which correspond to oslo.messaging RPC target and queues which correspond to oslo.messaging RPC target
:return Dictionary, declared_queue_name -> no_ack_mode :return Dictionary: declared_queue_name -> no_ack_mode
""" """
queue_expiration = self._pika_engine.rpc_queue_expiration queue_expiration = self._pika_engine.rpc_queue_expiration
@ -465,7 +465,7 @@ class RpcReplyPikaPoller(PikaPoller):
"""Overrides base method and perform declaration of RabbitMQ exchange """Overrides base method and perform declaration of RabbitMQ exchange
and queue used for RPC reply delivery and queue used for RPC reply delivery
:return Dictionary, declared_queue_name -> no_ack_mode :return Dictionary: declared_queue_name -> no_ack_mode
""" """
self._pika_engine.declare_queue_binding_by_channel( self._pika_engine.declare_queue_binding_by_channel(
channel=self._channel, channel=self._channel,
@ -513,7 +513,7 @@ class NotificationPikaPoller(PikaPoller):
"""Overrides base method and perform declaration of RabbitMQ exchanges """Overrides base method and perform declaration of RabbitMQ exchanges
and queues used for notification delivery and queues used for notification delivery
:return Dictionary, declared_queue_name -> no_ack_mode :return Dictionary: declared_queue_name -> no_ack_mode
""" """
queues_to_consume = [] queues_to_consume = []
for target, priority in self._targets_and_priorities: for target, priority in self._targets_and_priorities: