python / python/typing

Spec: PEP leftovers in the spec for literals

オープン 初心者向け
#2,355 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

topic: typing spec
主要言語
Python
スター
1.8k
フォーク
302
平均マージ
23時間
マージ済み PR(30日)
8

説明

There are some sections in the spec for literals that made sense as a rationale or look into the future in the PEP, but should be removed in the spec for conciseness, clarity, and consistency:

  • An (incomplete) list of illegal parameters for Literal. Since this immediately succeeds a positive, exclusive list of what parameters are allowed, this is just fluff and I believe the whole section should just be removed.
  • The next section is titled "Parameters at runtime" and details implementation details for Literal. These seem unnecessary for the typing spec and are in danger of getting desynched with the actual implementation.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

リテラルの仕様を開き、issue で言及されている不正なパラメーターと実行時のパラメーターに関するセクションを見つけます。規範的な記述を簡潔に保ちながら、根拠と実装詳細のセクションを削除し、その後、レンダリングされた仕様を確認して周辺の内容が引き続き明確であることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
75/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。