Azure / Azure/azure-sdk-for-python

[Cosmos] Include typehints for internal files

Aperta
#41,989 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Client Cosmos needs-team-attention Service Attention
Lingua principale
Python
Stelle
5.6k
Fork
3.4k
Merge medio
2g 2h
PR unite (30g)
213

Descrizione

Most of the internal methods and files in the SDK don't have proper typehinting the way our public surface area does, which makes it harder for developers to know exactly what each relevant argument is. This issue serves as a tracking item to get that documentation rolled out properly, in order to ensure that moving forward we can do better.

Ideally, the work would be divided into separate PRs on either sets of similar files, sets of similar features, or even individual files in order to more easily review - otherwise reviewing the entire SDK in one go would likely take a long time.

Follow up to comments made in https://github.com/Azure/azure-sdk-for-python/pull/41272.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Leggi la discussione successiva in PR 41272 ed esamina i metodi e i file interni del Python SDK per identificare un piccolo gruppo coerente per una modifica separata. Il lavoro è completato quando le API interne selezionate hanno Type Hints paragonabili a quelli della superficie pubblica e la modifica mirata può essere revisionata indipendentemente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
developer-experience
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.