python / python/cpython

Incorrect anchor tags generated in documentation

Đang mở
#155,799 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

I have spotted a couple of incorrect anchor links from the pilcrows in some docs pages. It looks like a the sphinx index directive and the headings should be swapped. I will create a pull request.

In The Python Language Reference » 6. Expressions » Identifiers (Names) the pilcrow links to #atom-identifiers instead of #identifiers-names.

In The Python Language Reference » 6. Expressions » Private name mangling the pilcrow links to #index-5 instead of #private-name-mangling.

In Python/C API reference manual » Concrete Objects Layer » MemoryView objects the pilcrow links to #index-0 instead of #memoryview-objects.

I have raised an issue rather than going straight for a PR because you might have concerns about breaking links?

Linked PRs
  • gh-155800

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 các chỉ thị chỉ mục và tiêu đề Sphinx tương ứng với ba trang tài liệu Python được trích dẫn, sau đó kiểm tra PR được liên kết gh-155800. Được xem là hoàn tất khi các neo pilcrow phân giải đến các neo tiêu đề đã được tài liệu hóa cho Identifiers (Names), Private name mangling và MemoryView objects mà không gây hỏng liên kết ngoài ý muố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ó
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.