python / python/typeshed

Improving type annotations in Sphinx

Offen
#11,621 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
5.1k
Forks
2.1k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
82

Beschreibung

@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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der Durchsicht des Sphinx-PRs #12012 und der dort beschriebenen verbleibenden Fehler. Vergleiche die Annotationen von docutils-stubs und types-docutils und ermittle dabei, welche Fehler zu Sphinx und welche zu den Typannotationen gehören. Als abgeschlossen gilt die Aufgabe, wenn die verbleibenden Fehler behoben sind und Sphinx typeshed verwenden kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Refactoring
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.