plotly / plotly/plotly.js

[mkdocs] Missing backslashes in test/plot-schema.json

Ouverte
#7,620 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug
Langage dominant
JavaScript
Étoiles
18.3k
Forks
2k
Merge moyen
2 j 12 h
PR mergées (30 j)
28

Description

In test/plot-schema.json, this sentence: The URI consists of \"data:image/[<media subtype>][;base64],<data>\"" does not render properly because the brackets are not escaped. This happens when test/plot-schema.json is copied over into plotly.py docs and used to render docstrings (and eventually into markdown). If you add the necessary backslashes, then it will fix the rendering in plotly.py docs but render with the backslashes in plotly.js.

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 phrase dans test/plot-schema.json et suivez la manière dont ce fichier est copié dans la documentation de plotly.py, puis rendu en markdown ou plotly.js. Comparez la sortie dans les deux chemins ; l’issue n’est terminée que lorsque les crochets sont rendus correctement sans introduire de barres obliques inverses indésirables dans plotly.js.

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

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
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.