Future of typing_extensions.Doc
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 30/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず typing_extensions.Doc の現在のドキュメントと issue にリンクされた議論を確認し、次に IntVar の扱いと比較してください。プロジェクトが Doc をどのように扱うかを決定し、その決定がドキュメントに反映された時点で issue は完了です。採用する場合は、非推奨化とセクションの配置も含めます。
索引モデルが issue の本文から書いたものです。
説明
PEP-727 proposed a new Doc construct, but the PEP is unlikely to be accepted and will probably be withdrawn (https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566/181).
That makes it so we have to figure out what to do with typing_extensions.Doc in the future. We don't have any previous cases where a feature was proposed in a PEP that didn't get accepted. We do have the precedent of typing_extensions.IntVar, which was added a long time ago without ever being proposed in a PEP. It is still in typing_extensions but undocumented.
I'm hesitant to remove importable objects from typing_extensions, because this library is so widely used and is a dependency of many other important libraries. If we remove something, we could end up breaking an important third-party library. Libraries could also end up pinning the version of typing-extensions they depend on, which is disruptive because it restricts users using that library from using new features of newer versions of typing-extensions.
Doc is also quite simple (a single class of a few dozen lines; no interaction with other features). Therefore, I don't see a big problem with keeping it around. However, we should mark it as deprecated in the documentation and probably move it into its own section.
- 主要言語
- Python
- スター
- 583
- フォーク
- 146
- 平均マージ
- 10時間 11分
- マージ済み PR（30日）
- 5
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
python/typing_extensions のほかの issue
-
Dependency Dashboard オープン
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
python/typing_extensions#793 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
python/typing_extensions#681 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
python/typing_extensions#672 · コメント 10 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
python/typing_extensions#643 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
python/typing_extensions#636 ·
python/typing_extensions の issue をすべて見る
似ている issue
-
link-check link-check:sphinx-theme
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
OpenHands/extensions#626 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
CSCfi/sd-search-api#39 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100