python / python/typing

Typing spec: Improve cross-linking

オープン
#1,531 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

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

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

説明

We should improve links within the spec. Concretely:

  • Replace links to PEPs with links to the relevant part of the spec (https://github.com/python/typing/pull/1517#pullrequestreview-1763857938)
  • Where we mention a feature, link it to the relevant spec section (e.g., whenever we mention Annotated, it should link to the spec section that describes Annotated).
  • Strategically add link targets so other Sphinx docs (e.g., docs.python.org, the PEPs) can link to the spec

This can be done in small increments, one PR at a time, and doesn't need signoff from the Typing Council. Contributions are welcome.

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

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

はじめの一歩

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

調査の方向性

まず、リンクされた typing spec を確認します。特に、型システムのページと参照されている pull request を確認してください。更新する PEP または feature の参照を小さなグループとして特定し、その後、関連する spec のセクションにリンクが設定されていること、および追加したリンク先が生成されたドキュメントで正しく解決されることを確認してください。

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

評価

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

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

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