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

Generate proper documentation

Đang mở
  • Có gì không ổn?
#214 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
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 việc xem xét README.md và CHANGELOG.md, sau đó so sánh thiết lập tài liệu hiện tại của dự án với workflow ReadTheDocs và Sphinx được đề cập mà Trio sử dụng. Xác định cấu trúc tài liệu, cách tiếp cận liên kết siêu văn bản và cách xử lý thông báo lỗi trước khi thực hiện thay đổi; công việc được hoàn tất khi thông tin dự án và hướng dẫn về mã lỗi được sắp xếp, đồng thời các liên kết hoặc nội dung được tạo vẫn dễ bảo trì.

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

Mô tả

documentation prioritized

README.md has grown to 200 lines, and spans error codes, installation & run instructions, configuration and command-line flags. We also have CHANGELOG.md with 150 lines.
There are a few links in the readme, but it would probably be quite useful to have anything referring to [objects within] urllib3, httpx, anyio, asyncio, trio, etc be hyperlinks w/o having to manually update.
Pulling out the error messages for the documentation automatically would be nice, but somewhat complicated given the current setup for messages differing for different (combinations of) libraries. Should be quite doable though.

https://github.com/python-trio/flake8-async/issues/211#issuecomment-1971778351

I'm planning to write up some more detail about each of our error codes in a long doc, hopefully this weekend, which will include much more about why you'd want to enable each of the optional rules in addition to the existing material.

This also sounds like great doc material.

The one workflow I'm decently accustomed to is ReadTheDocs+Sphinx as used in python-trio/trio, and probably nice to be consistent with it since it's in the same organization. But it's also been a huge pain to work with at times.

Ngôn ngữ chính
Python
Star
26
Fork
11
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

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-trio/flake8-async

Tất cả issue của python-trio/flake8-async

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.