DOC: add Example sections to snapshot and list_labels methods in Azur…#47963
Conversation
…eAppConfigurationClient
|
Thank you for your contribution @shoumikchakravarty-dev! We will review the pull request and get back to you soon. |
|
@shoumikchakravarty-dev please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
There was a problem hiding this comment.
Pull request overview
This is a documentation-only PR that adds Example sections to six public methods of AzureAppConfigurationClient (both sync and async) that were introduced with the configuration snapshot feature but lacked example code in their docstrings. The examples follow the existing docstring style and mirror the usage in the repository's snapshot sample files, improving generated reference docs without changing any behavior.
Changes:
- Added
Exampledocstring blocks forlist_labels,begin_create_snapshot,archive_snapshot,recover_snapshot,get_snapshot, andlist_snapshotsin the sync client. - Added the equivalent async examples (using
async forandawait) in the async client.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/_azure_appconfiguration_client.py | Adds Example docstring blocks to six sync methods, matching existing convention and sample usage. |
| sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_azure_appconfiguration_client_async.py | Adds Example docstring blocks to the six corresponding async methods with correct async for/await usage. |
Description
Adds Example sections to six public methods in AzureAppConfigurationClient (sync and async) that were missing them. These methods were introduced as part of the configuration snapshot feature but did not receive example code in their docstrings at the time.
Methods updated (both _azure_appconfiguration_client.py and _azure_appconfiguration_client_async.py):
The examples follow the same style and format used by the other methods in the client (e.g. get_configuration_setting, add_configuration_setting) and are consistent with the usage shown in the existing snapshot_sample.py and snapshot_sample_async.py sample files. No logic or behaviour is changed — this is a documentation-only PR.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines