remove duplicate __init__ docstring in AutoLockRenewer#40562
Merged
l0lawrence merged 1 commit intoAzure:mainfrom Apr 18, 2025
Merged
remove duplicate __init__ docstring in AutoLockRenewer#40562l0lawrence merged 1 commit intoAzure:mainfrom
l0lawrence merged 1 commit intoAzure:mainfrom
Conversation
The class- and __init__-level docstrings for AutoLockRenewer both contained identical parameter descriptions, causing eight parameter tables to appear instead of the intended four. This commit removes the __init__ docstring block and centralizes all documentation in the class-level docstring. - Delete duplicate docstring in __init__. - Retain summary and Attributes section in class-level docstring. - Ensure Sphinx/AutoAPI generates only the correct four parameters. This prevents erroneous “required” flags on defaulted parameters and keeps the API reference clean and accurate.
Ikwus
requested review from
annatisch,
kashifkhan,
l0lawrence and
swathipil
as code owners
github-actions
bot
added
Community Contribution
|
Thank you for your contribution @Ikwus! We will review the pull request and get back to you soon. |
Contributor
Author
|
@microsoft-github-policy-service agree |
Collaborator
|
API change check API changes are not detected in this pull request. |
l0lawrence
approved these changes
Apr 18, 2025
kashifkhan
approved these changes
Apr 18, 2025
Member
|
Thanks @Ikwus |
cRui861
pushed a commit
that referenced
this pull request
May 14, 2025
The class- and __init__-level docstrings for AutoLockRenewer both contained identical parameter descriptions, causing eight parameter tables to appear instead of the intended four. This commit removes the __init__ docstring block and centralizes all documentation in the class-level docstring. - Delete duplicate docstring in __init__. - Retain summary and Attributes section in class-level docstring. - Ensure Sphinx/AutoAPI generates only the correct four parameters. This prevents erroneous “required” flags on defaulted parameters and keeps the API reference clean and accurate.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR removes the redundant
__init__-level docstring from theAutoLockRenewerclass, consolidating all parameter documentation into the class-level docstring. This change ensures that the generated documentation correctly displays only four parameter tables, avoiding duplication.https://learn.microsoft.com/en-us/python/api/azure-servicebus/azure.servicebus.autolockrenewer?view=azure-python
__init__docstring block.This update prevents incorrect "required" flags on defaulted parameters and maintains clarity in the API reference documentation.
Checklist
General Guidelines and Best Practices