enhancement: docstring to be RST friendly.
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
从 prometheus_client/metrics.py 第 516 行附近的 Metrics docstring 开始，并使用 Sphinx 渲染其文档，以复现格式问题。当相关的 Metrics docstring 将其代码示例渲染为 RST 代码块而不是引用块时，即表示完成。
由索引模型根据 Issue 内容生成。
描述
This is probably not a bug, but I'm just wondering whether there is a decision not to make docstring for metrics RST-friendly.
Let's take the documentation for https://github.com/prometheus/client_python/blob/db391dbc83df4202698a21463ae89d6fb3611ce2/prometheus_client/metrics.py#L516 as an example.
The code block will not be rendered as a code block but as a quotes block when using Sphinx.
- 主要语言
- Python
- 星标
- 4.4k
- 派生
- 876
- 平均合并
- 8 天 4 小时
- 30 天内合并 PR
- 1
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
prometheus/client_python 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
prometheus/client_python#1177 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 45/100
prometheus/client_python#1210 ·
-
难度 2/5 1-3 小时 新手友好度 58/100
prometheus/client_python#1199 · 1 个 reaction ·
-
难度 5/5 一周以上 新手友好度 35/100
prometheus/client_python#1176 ·
-
难度 1/5 1-3 小时 新手友好度 52/100
prometheus/client_python#1126 · 2 条评论 ·
查看 prometheus/client_python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
stephrobert/dsoxlab#238 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
sublimehq/package_control#1780 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 70/100
nwg-piotr/nwg-displays#145 ·