realpython / realpython/python-guide
Ambiguity in the Structure section.
未關閉
還沒有人認領這個 Issue。
- 主要語言
- Batchfile
- 星號
- 29.8k
- 分支
- 5.9k
- PR 合併指標
- 30 天內沒有已合併 PR
描述
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?
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 docs/writing/structure.rst 的 Modules 部分開始,以連結的段落作為範圍。結合現有討論確認預期含義,並且僅在該含義明確時修改措辭;當渲染後的段落表意明確且保留原始指引時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 1/5
- 預估耗時
- 1 小時以內
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100