Azure / Azure/azure-sdk-for-python
[Cosmos] Include typehints for internal files
- Vorherrschende Sprache
- Python
- Sterne
- 5.6k
- Forks
- 3.4k
- Ø Merge
- 2 T. 2 Std.
- Gemergte PRs (30 T.)
- 213
Beschreibung
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.
Beitragsleitfaden
Rechercherichtung
Lies die anschließende Diskussion in PR 41272 und untersuche die internen Methoden und Dateien des Python SDK, um eine kleine, zusammenhängende Gruppe für eine separate Änderung zu identifizieren. Als abgeschlossen gilt die Aufgabe, wenn die ausgewählten internen APIs über Type Hints verfügen, die mit der öffentlichen Oberfläche vergleichbar sind, und die fokussierte Änderung unabhängig geprüft werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- developer-experience
- Issue-Typ
- Refactoring
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100