microsoft / microsoft/azure-devops-python-api
Implement type hints on top of docstring `rtype`
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 684
- Fork
- 218
- Merge trung bình
- 8 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
Hi,
The code is quite well documented, and uses docstring heavily. However, the "Python way" is to use type hints which are powerful and enable a good code completion.
For exaample, the client factory (get_git_client, get_build_client, ...) does not have type hints. Due to how it is written, python analyzers can not infer the returned types and this breaks autocompletion.
Could you please generate them them?
For example something like this:
def get_git_client(self) -> GitClient:
"""get_git_client.
Gets the 7.0 version of the GitClient
:rtype: :class:`<GitClient> <azure.devops.v7_0.git.git_client.GitClient>`
"""
return self._connection.get_client('azure.devops.v7_0.git.git_client.GitClient')
Thanks !
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xác định các phương thức factory của client được nêu trong issue, bao gồm get_git_client và get_build_client, đồng thời kiểm tra cách các khai báo rtype trong docstring của chúng tương ứng với các client được trả về. Xác định phạm vi các factory cần annotation và xác minh rằng các kiểu trả về thu được khôi phục tính năng tự động hoàn thành của analyzer; issue không nêu các tệp hoặc bài kiểm thử cụ thể.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- azure, python
- Lĩnh vực
- api
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 30/100