python / python/typeshed

Stubtest docs: common failure/suppression examples + debugging guidance

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

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

project: infrastructure
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ả

I feel like the contributing guide could benefit from instructions around debugging stubtest failures, and examples of things that stubtest can't handle that would warrant suppressions.

The mypy stubtest docs don't really go into enough detail or have enough examples, which makes it harder for new contributors (like myself) to debug failures.

Maybe we could improve that doc and link to it from CONTRIBUTING.md. I think that would reduce the need for maintainers to help stub contributors debug these failures, and make things a bit more self-service.

I'm happy to contribute to this, though I'm a bit too new to know which specific patterns are commonly suppressed.

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 với CONTRIBUTING.md và tài liệu mypy stubtest được liên kết, sau đó xác định hướng dẫn về gỡ lỗi và việc bỏ qua các lỗi stubtest nên được đặt ở đâu. Công việc được coi là hoàn tất khi đã thêm các ví dụ về lỗi và cách bỏ qua thường gặp, giải thích cách gỡ lỗi các lỗi, và liên kết tài liệu được cải thiện từ CONTRIBUTING.md.

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
documentation, testing-qa
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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
52/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.