Misleading visibility_timeout, Required vs optional parameters, updates needed!
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the linked QueueClient receive-message documentation and compare it with the referenced SDK corrections in commits 25f6410141c4613a8b48a8ebe8a22afac5ffe506 and e9d4668f61cb4705f488b041ff3e32abcb22ff19. Check the visibility_timeout wording and the required versus optional parameters for update_message and delete_message. Done means the published Python SDK documentation matches those corrections.
Written by the indexing model from the issue text.
Description
I see this correction on the sdk git but not on docs. Please update as needed.
The PR and commit:
https://github.com/MicrosoftDocs/azure-docs-sdk-python/pull/1548
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:
WHY is it optional, because
-
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.
-
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
Commit:
Please review and approve if it looks good.
- Dominant language
- Python
- Stars
- 172
- Forks
- 258
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from MicrosoftDocs/azure-docs-sdk-python
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
All issues in MicrosoftDocs/azure-docs-sdk-python
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100