Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use EditorBrowsableState.Never on ACR GetTagPropertiesCollection method. #31920

Merged
merged 1 commit into from
Oct 24, 2022

Conversation

annelo-msft
Copy link
Member

@annelo-msft annelo-msft commented Oct 20, 2022

We decided to GA the ACR library using the GetAll<resources> naming convention for pageable methods (used when the resource name is already plural), instead of the Get<resources>Collection convention. The rationale for this is described in this PR comment.

Unfortunately, the GetTagPropertiesCollection method was reintroduced with a bad merge in this PR.

This PR adds the [EditorBrowsable(EditorBrowsableState.Never)] attribute to these methods on the ACR client so they won't appear in Intellisense or docs, to guide callers to use the method consistent with .NET naming conventions.

@azure-sdk
Copy link
Collaborator

API change check

APIView has identified API level changes in this PR and created following API reviews.

Azure.Containers.ContainerRegistry

@pallavit
Copy link
Contributor

Is this considered a breaking change, if so, how do we version it? Do we add this in the readme changelog?

@annelo-msft
Copy link
Member Author

Is this considered a breaking change, if so, how do we version it? Do we add this in the readme changelog?

My understanding is that this is NOT a breaking change because it's not removing anything, just adding an attribute to an existing method. I believe it is a strategy we use commonly to hide methods in our APIs that we would in principle want to deprecate, but can't do that because of our no breaking change policy.

@tg-msft can correct/fill in any details I may have missed here?

@pallavit
Copy link
Contributor

Do we mention this in the changelog?

@annelo-msft
Copy link
Member Author

It doesn't look like storage or textanalytics have done this:

My instinct would be that changes to docs only wouldn't need to be called out in the CHANGELOG, unless they were substantial improvements, but if we have evidence of a team precedent or a strong feeling the other way, I'm fine adding it.

Copy link
Member

@ShivangiReja ShivangiReja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@annelo-msft annelo-msft merged commit c4f68f0 into Azure:main Oct 24, 2022
sofiar-msft pushed a commit to sofiar-msft/azure-sdk-for-net that referenced this pull request Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants