Clarify when to mark up numeric literals
オープン
まだ誰も着手していません。
needs: decision
topic-documentation
- 主要言語
- Python
- スター
- 2.1k
- フォーク
- 1k
- 平均マージ
- 2日 12時間
- マージ済み PR（30日）
- 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?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
issue でリンクされている devguide ドキュメントのマークアップセクションから始め、その文言を参照されている PR の議論と比較してください。数値リテラルについて、明確なルールと適切な例／不適切な例を示すようガイダンスを更新し、引用されている不整合を解消する曖昧さのない推奨事項によって完了を示してください。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100