TheAlgorithms / TheAlgorithms/Python
Suggestion: adopt a documentation format for docstring
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 225k
- Fork
- 51.1k
- Merge trung bình
- 1 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 156
Mô tả
As the number of algorithms are increasing, it might make sense to adopt a single documentation format for docstrings. Following are existing currently:
- Google Docstring: https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html
There are editor extensions which help in generating the docstring based on the chosen format like:
The doctest will come under the examples section for each of the above format.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách so sánh các định dạng Google Docstring, Numpydoc và Sphinx được liên kết trong issue, bao gồm cách mỗi định dạng xử lý các ví dụ doctest. Xem lại phần thảo luận để xác định liệu dự án đã chọn một định dạng hay chưa. Được xem là hoàn tất khi có một định dạng tài liệu đã được thống nhất và một cách xác định để áp dụng định dạng đó cho các docstring của thuật toá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ính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100