python / python/typeshed

Improving type annotations in Sphinx

Đang mở
#11,621 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
5.1k
Fork
2.1k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
82

Mô tả

@JelleZijlstra, @srittau thanks for all your help with the docutils type stubs.

The point of all these PRs is facilitate migrating the venerable Sphinx project from docutils-stubs to types-docutils.

There's a PR for that here - https://github.com/sphinx-doc/sphinx/pull/12012

there's still a number of errors remaining. Some are issues with Sphinx, others with the type annotations themselves.
I wonder if you have any bandwidth to help me get this PR over the line, and get Sphinx using typeshed once and for all?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng việc xem xét PR #12012 của Sphinx và các lỗi còn lại được mô tả trong đó. So sánh các annotation của docutils-stubs và types-docutils, đồng thời xác định lỗi nào thuộc về Sphinx và lỗi nào thuộc về các annotation kiểu. Hoàn thành khi các lỗi còn lại được xử lý và Sphinx có thể sử dụng typeshed.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
devtools
Loại issue
Tái cấu trúc
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.