python / python/devguide

Clarify when to mark up numeric literals

未關閉
#1,312 4 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

needs: decision topic-documentation
主要語言
Python
星號
2.1k
分支
1k
平均合併
2 天 12 小時
30 天內合併 PR
12

描述

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?

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 issue 中連結的 devguide 文件 markup 部分開始,並將其中的措辭與所引用的 PR 討論進行比較。更新指南,加入關於數值字面量的明確規則和正確/錯誤範例,並透過一項能解決所述不一致問題的明確建議來表明已完成。

由索引模型根據 Issue 內容生成。

評估

領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。