Clarify when to mark up numeric literals
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2.1k
- Fork
- 1k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 12
Mô tả
The current devguide recommendations reads:
backquotes: ``text`` for code samples, variables, and literals.
Earlier, I've been corrected to use double backticks when marking up literals. Example PR remark:
Recently, I've seen other styles enforced:
Perhaps we need a clarification, possibly with good/bad examples?
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 với phần markup trong tài liệu devguide được liên kết trong issue và so sánh cách diễn đạt của phần này với các cuộc thảo luận PR được tham chiếu. Cập nhật hướng dẫn bằng các quy tắc rõ ràng cùng các ví dụ đúng/sai về các literal số, và thể hiện rằng công việc đã hoàn tất bằng một khuyến nghị không mơ hồ để giải quyết điểm không nhất quán được nêu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- 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
- 45/100