Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR aims to fix documentation issues in the Azure Identity SDK by updating type annotations and enhancing docstrings throughout several modules. Key changes include:
- Updating return type annotations (adding a tilde prefix for canonical type references).
- Adding detailed docstrings for methods such as close(), authority(), client_id(), etc.
- Refining parameter and type descriptions to improve clarity.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/identity/azure-identity/azure/identity/aio/_internal/get_token_mixin.py | Updated return type in docstring for get_token_info. |
| sdk/identity/azure-identity/azure/identity/aio/_credentials/on_behalf_of.py | Added a docstring for the close method. |
| sdk/identity/azure-identity/azure/identity/aio/_credentials/chained.py | Updated the type annotation for credentials in the docstring. |
| sdk/identity/azure-identity/azure/identity/_internal/msal_credentials.py | Enhanced close() method docstring with resource release information. |
| sdk/identity/azure-identity/azure/identity/_internal/interactive.py | Added a return description to the authenticate function. |
| sdk/identity/azure-identity/azure/identity/_exceptions.py | Improved the return documentation for scopes and claims properties. |
| sdk/identity/azure-identity/azure/identity/_credentials/client_assertion.py | Added a detailed docstring for the close method. |
| sdk/identity/azure-identity/azure/identity/_constants.py | Added documentation to the AzureAuthorityHosts class. |
| sdk/identity/azure-identity/azure/identity/_auth_record.py | Added return documentation for various account property methods. |
Comments suppressed due to low confidence (1)
sdk/identity/azure-identity/azure/identity/aio/_internal/get_token_mixin.py:107
- A duplicate diff for get_token_mixin appears in the PR. Please verify if this redundancy is intentional or if the diff can be consolidated to avoid potential confusion.
:rtype: ~azure.core.credentials.AccessTokenInfo
pvaneck
approved these changes
May 28, 2025
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.
No description provided.