matrix-org/synapse

We should generate and publish documentation for the Module API using Sphinx

Open

#10,687 创建于 2021年8月24日

在 GitHub 查看
 (9 评论) (0 反应) (0 负责人)Python (2,196 fork)batch import
S-TolerableT-Enhancementgood first issue

仓库指标

Star
 (11,713 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

Document the get_userinfo_by_id method in the ModuleApi.

The function was added in #9581, but there are no user-facing docs describing it.

贡献者指南

研究方向
熟悉 Synapse 项目的文档结构和 Sphinx 配置，然后通过添加文档字符串或 RST 文件来记录 ModuleApi 类中的 `get userinfo by id` 方法。
技术栈
python
领域
backendapi
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonSphinxGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75