Document Structure and Wishlist
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 20/100
- Type d'issue
- Documentation
- Clarté
- À clarifier
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Examinez les sections proposées Tutorials, /guides, /reference, /spec et Links de niveau supérieur, ainsi que les issues liées #891, #905 et #851. Déterminez quel travail de documentation reste à effectuer et divisez la vaste liste de souhaits en tâches spécifiques et réalisables ; aucun achèvement n’est défini pour l’issue actuelle.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Python
- Étoiles
- 1.8k
- Forks
- 302
- Merge moyen
- 23 h
- PR mergées (30 j)
- 8
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de python/typing
-
topic: typing spec
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
topic: typing spec
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
topic: documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
-
topic: documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
topic: conformance tests topic: typing spec
Difficulté 3/5 1-2 jours Accessibilité débutants 72/100
Toutes les issues de python/typing
Issues similaires
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
stephrobert/dsoxlab#238 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
sublimehq/package_control#1780 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
nwg-piotr/nwg-displays#145 ·