apache/beam

Annotate code references inside inline documentation in Python-SDK

Open

#18,232 创建于 2022年6月3日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Java (4,097 fork)batch import
P3coregood first issueimprovementpython

仓库指标

Star
 (7,313 star)
PR 合并指标
 (平均合并 6天) (30 天内合并 243 个 PR)

描述

Some of the inline documentation in Python-SDK contains references to classes, methods or fields. The document generation tool (Sphinx) supports annotating such code blocks.

If the inline documentation is annotated properly then the references will be linked (clickable) on the generated site.

Relevant Sphinx documentation: http://www.sphinx-doc.org/en/stable/markup/inline.html#xref-syntax

Imported from Jira BEAM-1756. Original Jira may contain additional context. Reported by: tibor.kiss@gmail.com.

贡献者指南

研究方向
在Python SDK的源代码内联文档中添加Sphinx交叉引用标记（例如:class:, :meth:, :func:），使生成的文档站点上的引用可点击。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonSphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90