Document Structure and Wishlist
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 20/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
Rechercherichtung
Prüfe die vorgeschlagenen Abschnitte Tutorials, /guides, /reference, /spec und Links auf oberster Ebene sowie die verknüpften Issues #891, #905 und #851. Ermittle, welche Dokumentationsarbeiten noch ausstehen, und teile die umfassende Wunschliste in konkrete, umsetzbare Aufgaben auf; für den aktuellen Issue ist kein Abschluss definiert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Here is how I envision the typing documentation to be structured:
Tutorials
User-facing basic and advanced introductions to the type system or particular aspects of it. Non-comprehensive.
- Typing tutorial – from the ground up (#891)
- Type stub tutorial – writing a type stub for an existing library, stubgen, contributing to typeshed
Howto Guides
Directory: /guides
User-facing guides to accomplish particular tasks.
- How to add typing to an existing code base
- How to annotate a library (#905)
Reference
Directory: /reference
User-facing, comprehensive reference of the type system.
- Link to the typing module documentation
- Probably needs a review
- #851
- Type stub syntax and supported constructs
- Type stub style guide
Type System Specification
Directory: /spec
Territory of the Typing Council. Targeted at type checker developers. Here be dragons. 🐉
Links
Top level.
- Links to all typing-related PEPs
- Links to type checkers and other typing tools
Additions, corrections, criticism welcome!
2014-09-02: Updated to reflect the addition of the type system spec. Also, added explanations to the categories.
- Vorherrschende Sprache
- Python
- Sterne
- 1.8k
- Forks
- 302
- Ø Merge
- 23 Std.
- Gemergte PRs (30 T.)
- 8
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus python/typing
-
topic: typing spec
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
-
topic: typing spec
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
-
topic: documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
-
topic: documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
topic: conformance tests topic: typing spec
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 86/100
browser-use/browser-use#5905 ·
-
type: enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
ynput/ayon-python-api#363 ·
-
bug needs triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
modelscope/FunASR#3728 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
open-compass/opencompass#2655 ·