[mkdocs] Missing backslashes in test/plot-schema.json
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the sentence in test/plot-schema.json and trace how that file is copied into plotly.py docs and then rendered in markdown or plotly.js. Compare the output in both paths; the issue is done only when the brackets render correctly without introducing unwanted backslashes in plotly.js.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100