MicrosoftDocs / azure-docs-sdk-python

Azure Python SDK documentation, hosted on docs.microsoft.com.
https://docs.microsoft.com/python/api
Creative Commons Attribution 4.0 International
128 stars 248 forks source link

Misleading visibility_timeout, Required vs optional parameters, updates needed! #1552

Open Vignesh-Microsoft opened 2 years ago

Vignesh-Microsoft commented 2 years ago

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:

https://github.com/MicrosoftDocs/azure-docs-sdk-python/pull/1548

https://github.com/MicrosoftDocs/azure-docs-sdk-python/commit/25f6410141c4613a8b48a8ebe8a22afac5ffe506

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:

https://github.com/MicrosoftDocs/azure-docs-sdk-python/commit/e9d4668f61cb4705f488b041ff3e32abcb22ff19

Please review and approve if it looks good.

jalauzon-msft commented 2 years ago

Ported this to the SDK repo: https://github.com/Azure/azure-sdk-for-python/issues/24397