Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Typing spec: Improve cross-linking

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

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

Đánh giá

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

Hướng nghiên cứu

Bắt đầu bằng cách xem lại typing spec được liên kết, đặc biệt là trang về hệ thống kiểu và pull request được tham chiếu. Xác định một nhóm nhỏ các tham chiếu PEP hoặc feature cần cập nhật, sau đó kiểm tra rằng các phần spec liên quan đã được liên kết và mọi đích liên kết được thêm vào đều được phân giải chính xác trong tài liệu được tạo.

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

Mô tả

topic: documentation topic: typing spec

We should improve links within the spec. Concretely:

  • Replace links to PEPs with links to the relevant part of the spec (https://github.com/python/typing/pull/1517#pullrequestreview-1763857938)
  • Where we mention a feature, link it to the relevant spec section (e.g., whenever we mention Annotated, it should link to the spec section that describes Annotated).
  • Strategically add link targets so other Sphinx docs (e.g., docs.python.org, the PEPs) can link to the spec

This can be done in small increments, one PR at a time, and doesn't need signoff from the Typing Council. Contributions are welcome.

Ngôn ngữ chính
Python
Star
1.8k
Fork
302
Merge trung bình
23 giờ
Pull request đã merge (30 ngày)
8

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

  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.

Issue khác của python/typing

Tất cả issue của python/typing

Issue tương tự

Thêm issue về Python

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.