Skip to content

Commit 2ed4188

Browse files
authored
[Service Bus] Doc Updates For Message Browsing (Azure#28209)
* doc updates * Jesses feedback * trailing whitespace
1 parent 69d88e0 commit 2ed4188

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

sdk/servicebus/azure-servicebus/azure/servicebus/_servicebus_receiver.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -783,8 +783,10 @@ def peek_messages(
783783
Peeked messages are not removed from queue, nor are they locked. They cannot be completed,
784784
deferred or dead-lettered.
785785
786-
:param int max_message_count: The maximum number of messages to try and peek. The default
787-
value is 1.
786+
For more information about message browsing see https://aka.ms/azsdk/servicebus/message-browsing
787+
788+
:param int max_message_count: The maximum number of messages to try and peek. The actual number of messages
789+
returned may be fewer and are subject to service limits. The default value is 1.
788790
:keyword int sequence_number: A message sequence number from which to start browsing messages.
789791
:keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
790792
The value must be greater than 0 if specified. The default value is None, meaning no timeout.

sdk/servicebus/azure-servicebus/azure/servicebus/aio/_servicebus_receiver_async.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -770,8 +770,10 @@ async def peek_messages(
770770
Peeked messages are not removed from queue, nor are they locked. They cannot be completed,
771771
deferred or dead-lettered.
772772
773-
:param int max_message_count: The maximum number of messages to try and peek. The default
774-
value is 1.
773+
For more information about message browsing see https://aka.ms/azsdk/servicebus/message-browsing
774+
775+
:param int max_message_count: The maximum number of messages to try and peek. The actual number of messages
776+
returned may be fewer and are subject to service limits. The default value is 1.
775777
:keyword int sequence_number: A message sequence number from which to start browsing messages.
776778
:keyword Optional[float] timeout: The total operation timeout in seconds including all the retries.
777779
The value must be greater than 0 if specified. The default value is None, meaning no timeout.

0 commit comments

Comments
 (0)