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 (11,713 star) (2,196 fork)batch import
S-TolerableT-Enhancementgood first issue

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonSphinxSynapse codebase
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
Look at the documentation structure in the Synapse repository (likely under `docs/`). The method `get userinfo by id` was introduced in PR #9581; examine that PR to understand the method's signature and behavior. Follow existing Sphinx documentation patterns (e.g., `.rst` files) and add an entry describing the method, its arguments, return values, and usage. Ensure the documentation builds correctly with Sphinx. If unclear about where to place the documentation, check existing module API docs or ask in the issue comments.