plotly.js icon indicating copy to clipboard operation
plotly.js copied to clipboard

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

Open daexs opened this issue 1 month ago • 2 comments

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.

daexs avatar Nov 12 '25 17:11 daexs

Hi! I'd like to work on this issue. I've reviewed the problem with test/plot-schema.json where unescaped brackets break Markdown rendering in plotly.py docs. I can submit a PR that properly escapes the brackets for Python docstrings while keeping the JSON compatible with plotly.js.

Please assign this issue to me. Thanks!

KirtiGautam620 avatar Nov 15 '25 13:11 KirtiGautam620

@KirtiGautam620 thank you for volunteering. This particular issue is tracking work in a larger project with a lot of subtle context. Unfortunately it's probably not a good fit for someone not already familiar with the project. We would love your help on other more standalone issues though!

robertclaus avatar Nov 20 '25 16:11 robertclaus