Azure / Azure/azure-sdk-for-python

[doc] update migration doc

Aperta
#43,840 0 commenti 0 reazioni 1 assegnatario Rivendicata da @msyyc Vedi su GitHub
Mgmt
Lingua principale
Python
Stelle
5.6k
Fork
3.4k
Merge medio
2g
PR unite (30g)
217

Descrizione

Python SDK architect provide some suggestions in e-mail `RE: Confirmation about Azure MGMT Python SDK release for brownfield service which already converts from Swagger to Typespec` about migration doc for Typespec:
```
We can improve on the descriptions as to why we are making the breaking changes; most of them are (ironically) to avoid future breaking changes; e.g.

* additional_properties captured properties not yet documented. Unfortunately, that had the effect of breaking callers that fished them out from additional_properties when we added documentation for the property.
* flattening had similar problems when new properties were added to what used to be a flattened model.
* the serialize/deserialize ended were not entirely symmetrical leading to hard to debug failures if callers tried to use them to store raw data.

I would not claim that keyword-only arguments give IDEs better intellisense; the reason we make them keyword-only was also because it helped the models evolve over time. Previously, making a parameter optional could cause a breaking change.

```

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.