Azure / Azure/azure-sdk-for-python

[Cosmos] Include typehints for internal files

Open
#41,989 1 comment 0 reactions 0 assignees View on GitHub
Client Cosmos needs-team-attention Service Attention
Dominant language
Python
Stars
5.6k
Forks
3.4k
Avg merge
1d 21h
Merged PRs (30d)
193

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.