python / python/cpython

Docs: inline markup in `c-api/typeobj.rst` legend is not rendered because of `.. code-block:: none`

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

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

docs
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

In Doc/c-api/typeobj.rst, the two legends that explain the "D" (default) and "I" (inheritance) columns of the PyTypeObject quick-reference table (lines 172–187) are wrapped in .. code-block:: none. Because code-block renders its content verbatim:

  • *PyType_Ready* and *NULL* appear with literal asterisks.
  • PyType_Ready is plain text instead of a cross-reference to :c:func:PyType_Ready.
  • NULL is plain text instead of the NULL inline literal used elsewhere in the same file.
Image
Linked PRs
  • gh-148962

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

Mở Doc/c-api/typeobj.rst và kiểm tra hai legend xung quanh các dòng 172–187. Kiểm tra cách tài liệu đã render xử lý tham chiếu chéo PyType_Ready và literal inline NULL ở nơi khác trong tệp. Công việc được hoàn tất khi cả hai legend đều render markup thay vì các dấu hoa thị dạng literal, với định dạng tham chiếu và literal như dự kiến.

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ó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả 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.