[Container Registry] Improved samples #18263
Conversation
...inerregistry/azure-containerregistry/azure/containerregistry/_container_repository_client.py
Outdated
Show resolved
Hide resolved
| @@ -402,6 +532,26 @@ def set_tag_properties(self, tag, permissions, **kwargs): | |||
| :type permissions: ContentPermissions | |||
| :returns: :class:`~azure.containerregistry.TagProperties` | |||
| :raises: :class:`~azure.core.exceptions.ResourceNotFoundError` | |||
|
|
|||
| Example | |||
There was a problem hiding this comment.
is there some sort of guideline on which samples should be inserted here vs. pointing to the samples folder? Was this just decided on due to length of sample?
There was a problem hiding this comment.
We don't have a great understanding of how customers are going to use the library, which means we have limited samples but I wanted to include how each client method would be used so this was my compromise.
There was a problem hiding this comment.
makes sense. Thinking from a user perspective, having samples in a samples folder + pointing to the sample file might be more useful than having the example here. Since both the code block and the pointer to the sample file insert the example into the sphinx documentation, users who look at the docs for examples will be covered in any case. However, there may be users that only look in the samples folder and will not be able to find anything.
But since you said you'll test things out in the UX studies, I'm good with this :)
...stry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py
Outdated
Show resolved
Hide resolved
...tainerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py
Show resolved
Hide resolved
sdk/containerregistry/azure-containerregistry/samples/README.md
Outdated
Show resolved
Hide resolved
...tainerregistry/azure-containerregistry/samples/async_samples/sample_delete_old_tags_async.py
Outdated
Show resolved
Hide resolved
...tainerregistry/azure-containerregistry/samples/async_samples/sample_delete_old_tags_async.py
Show resolved
Hide resolved
...tainerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py
Show resolved
Hide resolved
…egistry/_container_repository_client.py Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
…egistry/aio/_async_container_registry_client.py Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
…mples/sample_delete_old_tags_async.py Co-authored-by: swathipil <76007337+swathipil@users.noreply.github.com>
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment: |
…into azure_purview_catalog * 'master' of https://github.com/Azure/azure-sdk-for-python: ignore analysis for swagger readmes (Azure#18520) [purview] add azure-purview-nspkg (Azure#18518) [AppConfiguration] Appconfig consistency (Azure#18493) [Container Registry] Improved samples (Azure#18263) [Container Registry] renamings (Azure#18492) [ServiceBus] internal code rename and sample readme update (Azure#18516) [EventHub] update link in sample readme (Azure#18517) Post Process Event Names Script (Azure#18419) [Tables] use etag from entity if match condition is given (Azure#18271) adding operation-location to headers that are scrubbed (Azure#18514)
…into azure_purview_scanning * 'master' of https://github.com/Azure/azure-sdk-for-python: (550 commits) del useless files (Azure#18528) delete existing useless files for trafficmanager (Azure#18525) Define new replacer to replace keys in recording (Azure#18294) [purview] add purview nspkg to ci (Azure#18523) ignore analysis for swagger readmes (Azure#18520) [purview] add azure-purview-nspkg (Azure#18518) [AppConfiguration] Appconfig consistency (Azure#18493) [Container Registry] Improved samples (Azure#18263) [Container Registry] renamings (Azure#18492) [ServiceBus] internal code rename and sample readme update (Azure#18516) [EventHub] update link in sample readme (Azure#18517) Post Process Event Names Script (Azure#18419) [Tables] use etag from entity if match condition is given (Azure#18271) adding operation-location to headers that are scrubbed (Azure#18514) [Tables] Adds support for AzureNamedKeyCredential (Azure#18456) [Tables] delete_entity takes an entity instead of row and partition key (Azure#18269) [Tables] Removed TableEntity attribute wrapper (Azure#18489) [EventHub&ServiceBus] Bump uAMQP dependency (Azure#17942) [ServiceBus] add keyword override support to update_ methods in mgmt module (Azure#18210) Add compatibility switch to disable CAE (Azure#18148) ...
No description provided.