Error in documentation for receive_messages

[martinitus]

Regression of: #21378
Regressed in: #14855

The original issue was fixed here , but now the documentation again says, that the minimum is 0, where it actually seems to be 1.

azure-sdk-for-python/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py

Lines 470 to 477 in 66e2d1a

	:keyword int visibility_timeout:
	If not specified, the default value is 0. Specifies the
	new visibility timeout value, in seconds, relative to server time.
	The value must be larger than or equal to 0, and cannot be
	larger than 7 days. The visibility timeout of a message cannot be
	set to a value later than the expiry time. visibility_timeout
	should be set to a value smaller than the time-to-live value.
	:keyword int time_to_live:

and

azure-sdk-for-python/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py

Lines 555 to 561 in 66e2d1a

	:keyword int visibility_timeout:
	If not specified, the default value is 0. Specifies the
	new visibility timeout value, in seconds, relative to server time.
	The value must be larger than or equal to 0, and cannot be
	larger than 7 days. The visibility timeout of a message cannot be
	set to a value later than the expiry time. visibility_timeout
	should be set to a value smaller than the time-to-live value.

[martinitus]

Also the same documentation changes should be applied to the async client versions in the aio submodule.

[xiangyan99]

Thanks for the feedback, we’ll investigate asap.

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @xgithubtriage.

[jalauzon-msft]

Hi @martinitus Martin, thanks for the feedback. I agree the documentation needs to be updated for receive_message (singular) as the default value and minimum value are incorrect. This should match the documentation (that was fixed a while back) for receive_messages (plural).

For send_message however, I believe the documentation is correct. This documentation aligns with the service documentation for Put Message which is the API that backs this method. When sending a message, it is valid (and the default behavior) to set visibility timeout to 0 to make the message immediately visible.

We will create a PR soon to address receive_message (sync and async) though. Thanks!