realpython / realpython/python-guide
Ambiguity in the Structure section.
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Batchfile
- Star
- 29.8k
- Fork
- 5.9k
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
I'm a little confused as to what this passage from writing/structure means.
Readability means to avoid useless boilerplate text and clutter,
therefore some efforts are spent trying to achieve a certain level of brevity.
But terseness and obscurity are the limits where brevity should stop.
Could this be reworded as something like this?
Readability in this case refers to avoiding useless boilerplate text and
clutter, and some effort has been made to achieve a certain level of brevity
in Python's syntax. However, there is a fine line between terseness and
obscurity.
I'm not sure I'm correctly grasping the meaning of the text. Does it actually mean something completely different?
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 từ phần Modules của docs/writing/structure.rst, sử dụng đoạn được liên kết làm phạm vi. Xác nhận ý nghĩa dự định dựa trên phần thảo luận hiện có, sau đó chỉ sửa lại cách diễn đạt nếu ý nghĩa đó rõ ràng; được coi là hoàn tất khi đoạn được kết xuất không còn mơ hồ và vẫn giữ nguyên hướng dẫn ban đầu.
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
- Dưới một 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
- 35/100