plotly / plotly/plotly.js

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

Offen
#7,620 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug
Vorherrschende Sprache
JavaScript
Sterne
18.3k
Forks
2k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
28

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Satz in test/plot-schema.json und verfolge, wie diese Datei in die plotly.py-Dokumentation kopiert und anschließend in markdown oder plotly.js gerendert wird. Vergleiche die Ausgabe in beiden Pfaden; das Issue ist erst abgeschlossen, wenn die Klammern korrekt gerendert werden, ohne unerwünschte Backslashes in plotly.js einzuführen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.