Resolved queue references (Azure#40714)

weirongw23-msft · web-flow · commit 3f1ad07b16d7 · 2025-04-25T16:37:38.000-04:00
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py
@@ -73,12 +73,12 @@ class QueueClient(StorageAccountHostsMixin, StorageEncryptionMixin):
     :keyword str secondary_hostname:
         The hostname of the secondary endpoint.
     :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-        Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-        :class:`BinaryBase64EncodePolicy` or `None`.
+        Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+        ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
     :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
     :keyword message_decode_policy: The decoding policy to use on incoming messages.
-        Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-        :class:`BinaryBase64DecodePolicy` or `None`.
+        Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+        ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
     :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
     :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
         authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -167,12 +167,12 @@ def from_queue_url(
         :keyword str secondary_hostname:
             The hostname of the secondary endpoint.
         :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-            Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-            :class:`BinaryBase64EncodePolicy` or `None`.
+            Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+            ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
         :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
         :keyword message_decode_policy: The decoding policy to use on incoming messages.
-            Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-            :class:`BinaryBase64DecodePolicy` or `None`.
+            Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+            ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
         :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
         :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
             authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -232,12 +232,12 @@ def from_connection_string(
         :keyword str secondary_hostname:
             The hostname of the secondary endpoint.
         :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-            Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-            :class:`BinaryBase64EncodePolicy` or `None`.
+            Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+            ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
         :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
         :keyword message_decode_policy: The decoding policy to use on incoming messages.
-            Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-            :class:`BinaryBase64DecodePolicy` or `None`.
+            Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+            ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
         :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
         :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
             authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -325,7 +325,7 @@ def delete_queue(self, *, timeout: Optional[int] = None, **kwargs: Any) -> None:
 
         Note that deleting a queue is likely to take at least 40 seconds to complete.
         If an operation is attempted against the queue while it was being deleted,
-        an :class:`HttpResponseError` will be thrown.
+        an ~azure.core.exceptions.HttpResponseError will be thrown.
 
         :keyword int timeout:
             Sets the server-side timeout for the operation in seconds. For more details see
@@ -467,7 +467,7 @@ def set_queue_access_policy(
         When you establish a stored access policy on a queue, it may take up to
         30 seconds to take effect. During this interval, a shared access signature
         that is associated with the stored access policy will throw an
-        :class:`HttpResponseError` until the access policy becomes active.
+        ~azure.core.exceptions.HttpResponseError until the access policy becomes active.
 
         :param signed_identifiers:
             SignedIdentifier access policies to associate with the queue.
@@ -550,7 +550,7 @@ def send_message(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A :class:`~azure.storage.queue.QueueMessage` object.
+            A ~azure.storage.queue.QueueMessage object.
             This object is also populated with the content, although it is not
             returned from the service.
         :rtype: ~azure.storage.queue.QueueMessage
@@ -831,7 +831,7 @@ def update_message(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A :class:`~azure.storage.queue.QueueMessage` object. For convenience,
+            A ~azure.storage.queue.QueueMessage object. For convenience,
             this object is also populated with the content, although it is not returned by the service.
         :rtype: ~azure.storage.queue.QueueMessage
 
@@ -948,10 +948,10 @@ def peek_messages(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that
+            A list of ~azure.storage.queue.QueueMessage objects. Note that
             next_visible_on and pop_receipt will not be populated as peek does
             not pop the message and can only retrieve already visible messages.
-        :rtype: list[~azure.storage.queue.QueueMessage]
+        :rtype: List[~azure.storage.queue.QueueMessage]
 
         .. admonition:: Example:
 
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py
@@ -406,7 +406,7 @@ def delete_queue(
 
         Note that deleting a queue is likely to take at least 40 seconds to complete.
         If an operation is attempted against the queue while it was being deleted,
-        an :class:`HttpResponseError` will be thrown.
+        an ~azure.core.exceptions.HttpResponseError will be thrown.
 
         :param queue:
             The queue to delete. This can either be the name of the queue,
@@ -438,7 +438,7 @@ def get_queue_client(self, queue: Union["QueueProperties", str], **kwargs: Any)
             The queue. This can either be the name of the queue,
             or an instance of QueueProperties.
         :type queue: str or ~azure.storage.queue.QueueProperties
-        :returns: A :class:`~azure.storage.queue.QueueClient` object.
+        :returns: A ~azure.storage.queue.QueueClient object.
         :rtype: ~azure.storage.queue.QueueClient
 
         .. admonition:: Example:
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py
@@ -79,12 +79,12 @@ class QueueClient(  # type: ignore [misc]
     :keyword str secondary_hostname:
         The hostname of the secondary endpoint.
     :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-        Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-        :class:`BinaryBase64EncodePolicy` or `None`.
+        Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+        ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
     :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
     :keyword message_decode_policy: The decoding policy to use on incoming messages.
-        Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-        :class:`BinaryBase64DecodePolicy` or `None`.
+        Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+        ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
     :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
     :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
         authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -190,12 +190,12 @@ def from_queue_url(
         :keyword str secondary_hostname:
             The hostname of the secondary endpoint.
         :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-            Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-            :class:`BinaryBase64EncodePolicy` or `None`.
+            Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+            ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
         :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
         :keyword message_decode_policy: The decoding policy to use on incoming messages.
-            Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-            :class:`BinaryBase64DecodePolicy` or `None`.
+            Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+            ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
         :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
         :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
             authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -255,12 +255,12 @@ def from_connection_string(
         :keyword str secondary_hostname:
             The hostname of the secondary endpoint.
         :keyword message_encode_policy: The encoding policy to use on outgoing messages.
-            Default is not to encode messages. Other options include :class:`TextBase64EncodePolicy`,
-            :class:`BinaryBase64EncodePolicy` or `None`.
+            Default is not to encode messages. Other options include ~azure.storage.queue.TextBase64EncodePolicy,
+            ~azure.storage.queue.BinaryBase64EncodePolicy or `None`.
         :paramtype message_encode_policy: BinaryBase64EncodePolicy or TextBase64EncodePolicy or None
         :keyword message_decode_policy: The decoding policy to use on incoming messages.
-            Default value is not to decode messages. Other options include :class:`TextBase64DecodePolicy`,
-            :class:`BinaryBase64DecodePolicy` or `None`.
+            Default value is not to decode messages. Other options include ~azure.storage.queue.TextBase64DecodePolicy,
+            ~azure.storage.queue.BinaryBase64DecodePolicy or `None`.
         :paramtype message_decode_policy: BinaryBase64DecodePolicy or TextBase64DecodePolicy or None
         :keyword str audience: The audience to use when requesting tokens for Azure Active Directory
             authentication. Only has an effect when credential is of type TokenCredential. The value could be
@@ -348,7 +348,7 @@ async def delete_queue(self, *, timeout: Optional[int] = None, **kwargs: Any) ->
 
         Note that deleting a queue is likely to take at least 40 seconds to complete.
         If an operation is attempted against the queue while it was being deleted,
-        an :class:`HttpResponseError` will be thrown.
+        an ~azure.core.exceptions.HttpResponseError will be thrown.
 
         :keyword int timeout:
             Sets the server-side timeout for the operation in seconds. For more details see
@@ -490,7 +490,7 @@ async def set_queue_access_policy(
         When you establish a stored access policy on a queue, it may take up to
         30 seconds to take effect. During this interval, a shared access signature
         that is associated with the stored access policy will throw an
-        :class:`HttpResponseError` until the access policy becomes active.
+        ~azure.core.exceptions.HttpResponseError until the access policy becomes active.
 
         :param signed_identifiers:
             SignedIdentifier access policies to associate with the queue.
@@ -573,7 +573,7 @@ async def send_message(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A :class:`~azure.storage.queue.QueueMessage` object.
+            A ~azure.storage.queue.QueueMessage object.
             This object is also populated with the content, although it is not
             returned from the service.
         :rtype: ~azure.storage.queue.QueueMessage
@@ -844,7 +844,7 @@ async def update_message(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A :class:`~azure.storage.queue.QueueMessage` object. For convenience,
+            A ~azure.storage.queue.QueueMessage object. For convenience,
             this object is also populated with the content, although it is not returned by the service.
         :rtype: ~azure.storage.queue.QueueMessage
 
@@ -961,7 +961,7 @@ async def peek_messages(
             see `here <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/storage/azure-storage-queue
             #other-client--per-operation-configuration>`__.
         :return:
-            A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that
+            A list of ~azure.storage.queue.QueueMessage objects. Note that
             next_visible_on and pop_receipt will not be populated as peek does
             not pop the message and can only retrieve already visible messages.
         :rtype: list[~azure.storage.queue.QueueMessage]
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py
@@ -405,7 +405,7 @@ async def delete_queue(
 
         Note that deleting a queue is likely to take at least 40 seconds to complete.
         If an operation is attempted against the queue while it was being deleted,
-        an :class:`HttpResponseError` will be thrown.
+        an ~azure.core.exceptions.HttpResponseError will be thrown.
 
         :param queue:
             The queue to delete. This can either be the name of the queue,
@@ -437,7 +437,7 @@ def get_queue_client(self, queue: Union["QueueProperties", str], **kwargs: Any)
             The queue. This can either be the name of the queue,
             or an instance of QueueProperties.
         :type queue: str or ~azure.storage.queue.QueueProperties
-        :returns: A :class:`~azure.storage.queue.aio.QueueClient` object.
+        :returns: A ~azure.storage.queue.aio.QueueClient object.
         :rtype: ~azure.storage.queue.aio.QueueClient
 
         .. admonition:: Example:
