From d7229a124fb29b37e5658b41fc6dac34df10adbb Mon Sep 17 00:00:00 2001 From: lingyongxu Date: Tue, 5 Sep 2017 15:10:35 +0800 Subject: [PATCH] Fix some reST field lists in docstrings 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 --- oslo_messaging/_drivers/pika_driver/pika_message.py | 2 +- oslo_messaging/_drivers/pika_driver/pika_poller.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/oslo_messaging/_drivers/pika_driver/pika_message.py b/oslo_messaging/_drivers/pika_driver/pika_message.py index 151fecfb6..2f79f056a 100644 --- a/oslo_messaging/_drivers/pika_driver/pika_message.py +++ b/oslo_messaging/_drivers/pika_driver/pika_message.py @@ -180,7 +180,7 @@ class RpcPikaIncomingMessage(PikaIncomingMessage, base.RpcIncomingMessage): :param failure: Tuple, should be a sys.exc_info() tuple. 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: diff --git a/oslo_messaging/_drivers/pika_driver/pika_poller.py b/oslo_messaging/_drivers/pika_driver/pika_poller.py index d34ddfe77..1c770a35b 100644 --- a/oslo_messaging/_drivers/pika_driver/pika_poller.py +++ b/oslo_messaging/_drivers/pika_driver/pika_poller.py @@ -218,7 +218,7 @@ class PikaPoller(base.Listener): exchange and (or) queue do not exist. Should be overridden in child classes - :return Dictionary, declared_queue_name -> no_ack_mode + :return Dictionary: declared_queue_name -> no_ack_mode """ raise NotImplementedError( "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 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 @@ -465,7 +465,7 @@ class RpcReplyPikaPoller(PikaPoller): """Overrides base method and perform declaration of RabbitMQ exchange 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( channel=self._channel, @@ -513,7 +513,7 @@ class NotificationPikaPoller(PikaPoller): """Overrides base method and perform declaration of RabbitMQ exchanges 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 = [] for target, priority in self._targets_and_priorities: