plotly / plotly/plotly.js

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

未关闭
#7,620 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

bug
主要语言
JavaScript
星标
18.3k
派生
2k
平均合并
2 天 12 小时
30 天内合并 PR
28

描述

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 test/plot-schema.json 中的句子开始,跟踪该文件如何被复制到 plotly.py 文档中,然后在 markdown 或 plotly.js 中渲染。比较两条路径中的输出;只有在括号能够正确渲染且不会在 plotly.js 中引入不需要的反斜杠时,issue 才算完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
documentation
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。