plotly / plotly/plotly.py

[mkdocs] No types or annotations for parameters

Ouverte
#5,408 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug P1
Langage dominant
Python
Étoiles
18.8k
Forks
2.8k
Merge moyen
16 h 26 min
PR mergées (30 j)
21

Description

  • Functions who include parameters in their docstring that are not explicitly written out in the function signature encounter a "Parameter '...' does not appear in the function signature" warning.
    • func(self, *args, **kwargs): all params in docstring raise warnings
  • Any parameters who do not have a type annotation (except **kwargs and any parameter in the function signature) raises a "No types or annotations for parameters ['parameter_name']"
    • engine (deprecated) : str does not render correctly on markdown causing missing type annotation error
    • annotation_* doesn't render correctly, adding "\\" renders "annotation" and adding "\\*" renders "annotation"

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 reproduire les cas documentés de *args/**kwargs, de engine obsolète et de annotation_* dans le chemin de rendu de la documentation MkDocs. Suivez la manière dont les noms des paramètres et les annotations sont analysés et rendus, puis vérifiez que les paramètres valides ne produisent plus d’avertissements et que leurs types s’affichent correctement en Markdown.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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