Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Error in documentation for receive_messages #21378

Closed
pgodofsk opened this issue Oct 22, 2021 · 4 comments · Fixed by #21463
Closed

Error in documentation for receive_messages #21378

pgodofsk opened this issue Oct 22, 2021 · 4 comments · Fixed by #21463
Assignees
@tasherif-msft
Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team. Storage Storage Service (Queues, Blobs, Files)

Comments

@pgodofsk
Copy link

pgodofsk commented Oct 22, 2021 •
edited
Loading

This is related to bug 19373: #19373
The documentation on docs.microsoft.com says that the minimum value for visibility_timeout is 0, when in fact it is 1. Also, it does not mention that the maximum for messages_per_page is 32. The visibility timeout limit is also incorrectly stated here.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Oct 22, 2021
@mccoyp
Copy link
Member

mccoyp commented Oct 22, 2021

Hi @pgodofsk, thank you for opening an issue! I'll tag the appropriate folks so we can take a look at this as soon as possible.

@mccoyp mccoyp added bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. CXP Attention Docs Storage Storage Service (Queues, Blobs, Files) and removed question The issue doesn't require a change to the product in order to be resolved. Most issues start as that needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. labels Oct 22, 2021
@ghost ghost added the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Oct 22, 2021
@SaurabhSharma-MSFT SaurabhSharma-MSFT self-assigned this Oct 22, 2021
@pgodofsk
Copy link
Author

One more thing--just a suggestion, not a bug: it might be worth mentioning that messages are dequeued (and thus subject to the visibility timeout) when a page is fetched, rather than when an individual message is retrieved from the page iterator. This is something that is I think kind of obvious in retrospect but might be surprising if you don't think about it.

@SaurabhSharma-MSFT SaurabhSharma-MSFT removed their assignment Oct 22, 2021
@SaurabhSharma-MSFT SaurabhSharma-MSFT added Service Attention Workflow: This issue is responsible by Azure service team. and removed CXP Attention labels Oct 22, 2021
@ghost
Copy link

ghost commented Oct 22, 2021

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

Issue Details

This is related to bug 19373: #19373
The documentation on docs.microsoft.com says that the minimum value for visibility_timeout is 0, when in fact it is 1. Also, it does not mention that the maximum for messages_per_page is 32. The visibility timeout limit is also incorrectly stated here.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Author: pgodofsk
Assignees: tasherif-msft
Labels:

bug, Storage, Docs, Service Attention, Client, customer-reported, needs-team-attention
Milestone: -

@tasherif-msft tasherif-msft mentioned this issue Oct 28, 2021
Merged
@tasherif-msft
Copy link
Contributor

Hi @pgodofsk, good observation, I have put our a PR to fix this here:
#21463

As for the me messages_per_page issue let's continue tracking it on the original issue as it seems it might be a bug in the way we generate docs. I have asked for an update on the matter here #19373

@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@tasherif-msft tasherif-msft

Labels
bug This issue requires a change to an existing behavior in the product in order to be resolved. Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team Service Attention Workflow: This issue is responsible by Azure service team. Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Visibility Timeout Doc Correction tasherif-msft/azure-sdk-for-python
5 participants
@pgodofsk @amishra-dev @SaurabhSharma-MSFT @mccoyp @tasherif-msft