plotly / plotly/react-plotly.js

Documentation encourages use of literals as props

Ouverte
#88 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
1.1k
Forks
138
Merge moyen
3 j 2 h
PR mergées (30 j)
4

Description

E.g. in the "Quick Start" section. The problem is that in the "State Management" section we show developers how to "close the loop" and if they use literals as props things will infinitely-loop!

Conclusion: we should scrub our docs and examples of the use of literals :(

See also #87

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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

Examinez les sections "Quick Start" et "State Management", puis inspectez la documentation et les exemples à la recherche de props littérales similaires. Confirmez les indications prévues avec issue #87 ; le travail est terminé lorsque les exemples documentés n’encouragent plus l’utilisation de littéraux susceptibles de provoquer une boucle infinie.

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

Évaluation

Stack technique
javascript, react
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

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