python / python/cpython

Replace some autogenerated Stable ABI notes with manual ones

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

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

docs topic-C-API
Ngôn ngữ chính
Python
Star
77.2k
Fork
35.9k
Chỉ số merge pull request
Chỉ số pull request đang chờ

Mô tả

Documentation

We generate Stable ABI notes automatically. This works well in most cases.
But in compact lists/tables of many similar definitions, the notes get repetitive, and take up too much vertical space:

Image

Let's skip the generated notes in this case, and manually add a common note before the table:

Image
Linked PRs
  • gh-156871
  • gh-156875

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

Xem xét việc tạo ghi chú Stable ABI được mô tả trong issue và so sánh các bảng gọn được hiển thị trong các ví dụ của issue. Issue không nêu tên tệp hoặc bài kiểm thử nào; hãy sử dụng các PR được liên kết gh-156871 và gh-156875 để xác định tài liệu bị ảnh hưởng và xác nhận rằng các ghi chú được tạo lặp lại được thay thế bằng một ghi chú thủ công dùng chung.

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