Document properties of internal type operations

Ouverte
#3,454 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
python
Domaine
devtools

Piste de recherche

The issue names no specific file, test, or entry point. Start by locating the internal type-operation implementations in the mypy source, then inventory the operations and their existing comments or docstrings; done means documenting their compatibility, subtyping, joins, meets, and other relevant properties.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation priority-1-normal refactoring

Document basic properties of all type operations used within mypy, including compatibility, proper subtyping, joins and meets. The properties include things like associativity, symmetry, how they work with Any -- and there are many other properties potentially worth documenting. The documentation would be in the form of comments or docstrings within the source code.

Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Merge moyen
1 j 18 h
PR mergées (30 j)
54

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de python/mypy

Toutes les issues de python/mypy

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.