python / python/typeshed

Improving type annotations in Sphinx

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

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

主要言語
Python
スター
5.1k
フォーク
2.1k
平均マージ
1日 19時間
マージ済み PR(30日)
82

説明

@JelleZijlstra, @srittau thanks for all your help with the docutils type stubs.

The point of all these PRs is facilitate migrating the venerable Sphinx project from docutils-stubs to types-docutils.

There's a PR for that here - https://github.com/sphinx-doc/sphinx/pull/12012

there's still a number of errors remaining. Some are issues with Sphinx, others with the type annotations themselves.
I wonder if you have any bandwidth to help me get this PR over the line, and get Sphinx using typeshed once and for all?

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

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

はじめの一歩

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

調査の方向性

まず Sphinx の PR #12012 と、そこに記載されている残りのエラーを確認します。docutils-stubs と types-docutils のアノテーションを比較し、どのエラーが Sphinx に属し、どのエラーが型アノテーションに属するのかを判断します。残りのエラーに対処し、Sphinx が typeshed を使用できるようになれば完了です。

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

評価

技術スタック
python
領域
devtools
issue の種類
リファクタリング
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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