matrix-org/synapse

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

Open

#10,687 opened on Aug 24, 2021

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)batch import
S-TolerableT-Enhancementgood first issue

Description

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.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinxSynapse codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.
We should generate and publish documentation for the Module API using Sphinx · matrix-org/synapse#10687 | Good First Issue