Better documentation for the HTML report
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 20.6k
- Forks
- 3.3k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Documentation
This is the only thing I can find in the docs about this HTML report, and it's far from complete. I could find these three questions on Stack Overflow, but none of them have satisfying answers (or answers at all).
I understand that mypy is reporting the presence of expressions of type Any in each line. (Is it? Did I get that right?) But what exactly do the colors mean? Why do lines with @overload always get colored red in my reports? Why do lines with isinstance always get colored yellow?
Guide de contribution
Ouvrir le guide de contribution
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.
Piste de recherche
Commencez par la documentation du rapport HTML en ligne de commande liée dans l’issue, puis utilisez les trois questions Stack Overflow liées pour identifier les explications manquantes. Documentez ce que mesure le rapport, ce que signifient ses couleurs et pourquoi des constructions telles que @overload et isinstance reçoivent les couleurs observées ; le travail est terminé lorsque les utilisateurs peuvent interpréter le rapport sans dépendre de questions externes restées sans réponse.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 52/100