Tweak doc.

This commit is contained in:
Anthony Tuininga 2021-04-23 13:48:03 -06:00
parent 7ad13e73d3
commit 9e8bc6676c
2 changed files with 24 additions and 18 deletions

View File

@ -60,18 +60,6 @@ used to enqueue and dequeue messages.
the attribute was changed from `deqOptions`. The old name will continue
to work for a period of time.
.. method:: Queue.enqone(message)
Enqueues a single message into the queue. The message must be a
:ref:`message property<msgproperties>` object which has had its payload
attribute set to a value that the queue supports.
.. versionchanged:: 8.2
For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `enqone()`. The old name will continue
to work for a period of time.
.. method:: Queue.enqmany(messages)
Enqueues multiple messages into the queue. The messages parameter must be a
@ -86,6 +74,24 @@ used to enqueue and dequeue messages.
:meth:`Queue.enqone()` instead. The function :meth:`Queue.deqmany()`
call is not affected.
.. versionchanged:: 8.2
For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `enqMany()`. The old name will continue
to work for a period of time.
.. method:: Queue.enqone(message)
Enqueues a single message into the queue. The message must be a
:ref:`message property<msgproperties>` object which has had its payload
attribute set to a value that the queue supports.
.. versionchanged:: 8.2
For consistency and compliance with the PEP 8 naming style, the name of
the method was changed from `enqOne()`. The old name will continue
to work for a period of time.
.. attribute:: Queue.enqoptions

View File

@ -58,9 +58,9 @@ if applicable. The most recent deprecations are listed first.
* - `Queue.enqOne`
- Replace with :meth:`Queue.enqone()`
* - `Queue.deqOptions`
- Replace with :data:`Queue.deqoptions()`
- Replace with :data:`Queue.deqoptions`
* - `Queue.enqOptions`
- Replace with :meth:`Queue.enqoptions()`
- Replace with :meth:`Queue.enqoptions`
* - `Queue.payloadType`
- Replace with :meth:`Queue.payload_type`
@ -116,13 +116,13 @@ if applicable. The most recent deprecations are listed first.
* - Name
- Comments
* - Connection.deq()
- Replace with :meth:`Queue.deqOne()` or :meth:`Queue.deqMany()`.
- Replace with :meth:`Queue.deqone()` or :meth:`Queue.deqmany()`.
* - Connection.deqoptions()
- Replace with attribute :attr:`Queue.deqOptions`.
- Replace with attribute :attr:`Queue.deqoptions`.
* - Connection.enq()
- Replace with :meth:`Queue.enqOne()` or :meth:`Queue.enqMany()`.
- Replace with :meth:`Queue.enqone()` or :meth:`Queue.enqmany()`.
* - Connection.enqoptions()
- Replace with attribute :attr:`Queue.enqOptions`.
- Replace with attribute :attr:`Queue.enqoptions`.
.. list-table:: Deprecated in 6.4