python / python/cpython

Python documentation in Texinfo format: Problems with `dircategory` and `direntry` commands

Đang mở
#130,517 5 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

The Python documentation could be downloaded in Texinfo and Info format.
Which is great, I'm very very thankful for it.

But their is multiple problems, in the python.texi file, with the @dircategory and @direntry commands.

The @dircategory is now set to "Miscellaneous". It should be set to a more descriptive category. Like "Programming" or "Programming language" or "Python". A "Python" category could be re-used by other manuals related to Python. For example a manual for a Python framework or library.

In the @direntry command:

  • The info file name, in parenthesis, should not include the .info extension [1]
  • The menu entry description should be more descriptive than "One line description of project"

[1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Listing-a-New-Info-File

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ở python.texi và kiểm tra các lệnh @dircategory và @direntry của nó, sau đó so sánh các giá trị hiện tại với hướng dẫn Texinfo được liên kết trong issue. Được xem là hoàn tất khi danh mục có tính mô tả, tên tệp Info bỏ phần mở rộng .info và mô tả menu xác định tài liệu Python thay vì sử dụng văn bản giữ chỗ.

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
1-3 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
35/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.