python / python/mypy

Plugin documentation is a little lacking

Ouverte
#9,020 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation priority-1-normal topic-plugins
Langage dominant
Python
Étoiles
20.6k
Forks
3.3k
Métriques de merge des PR
Métriques de PR en attente

Description

Ideally it should be possible to use the interface without having to dig through the source code, but that's not really possible. The docs mention that the callbacks returned by the hooks will receive APIs, but don't explain what those APIs are at all. It should also be mentioned that get_additional_deps has a different interface to the other plugin functions, and this detail should appear in the docs as well.

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.

Piste de recherche

Commencez par la documentation existante des plugins, en particulier les sections décrivant les callbacks des hooks et get_additional_deps. Documentez les APIs transmises aux callbacks et expliquez en quoi get_additional_deps diffère des autres fonctions des plugins. La tâche est terminée lorsque les utilisateurs peuvent comprendre ces interfaces sans lire le code source.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
50/100

Recevez les nouvelles issues par e-mail

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