MicrosoftDocs / azure-docs-sdk-python

Azure Python SDK documentation, hosted on docs.microsoft.com.

Home Page:https://docs.microsoft.com/python/api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Misleading visibility_timeout, Required vs optional parameters, updates needed!

Vignesh-Microsoft opened this issue · comments

I see this correction on the sdk git but not on docs. Please update as needed.

https://docs.microsoft.com/en-us/python/api/azure-storage-queue/azure.storage.queue.queueclient?view=azure-python#azure-storage-queue-queueclient-receive-message

The PR and commit:

#1548

25f6410

Also, for update_message, pop_receipt and content don't need to be a required parameter. One place it says optional but another it says required. Details below:

image

WHY is it optional, because

  1. pop_receipt is already part of the message object. pop_receipt is only required if message object is not there like in case of cli and powershell.

  2. if we are issuing an update call for visibility_timeout alone, we do not need content as required parameter so it is optional.

Same for delete_message

image

Commit:

e9d4668

Please review and approve if it looks good.

Ported this to the SDK repo: Azure/azure-sdk-for-python#24397