search

Azure / azure-sdk-for-python

This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python.
MIT License
4.55k stars 2.77k forks source link

[breaking change detector] distinguish `Enum` and `Model` in changelog #37171

Closed msyyc closed 2 weeks ago

msyyc commented 2 weeks ago

SDK models can be divided into two big kinds: Model and Enum so we would like them to be distinguished in changelog. For example: for https://github.com/azure-sdk/azure-sdk-for-python/pull/8279, the changelog is: image

Some models (e.g. CloudNativeType) are actually Enum: image

nit: base class of enum in generated SDKis alwaysstr, Enum` which is easy to use to distinguish with Model.

catalinaperalta commented 2 weeks ago

This is a duplicate of: https://github.com/Azure/azure-sdk-for-python/issues/36082. Closing in favor of the other issue. I'll pick this item up next.