element-hq / element-hq/synapse
We should generate and publish documentation for the Module API using Sphinx
Open
good first issue
S-Tolerable
T-Enhancement
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 600
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 51
Description
This issue has been migrated from [#10687](https://github.com/matrix-org/synapse/issues/10687).
---
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
Research direction
Locate the ModuleApi definition and the existing Sphinx documentation for its other methods, then follow the surrounding style. Document get_userinfo_by_id and build the Sphinx documentation to confirm the method appears in the published API docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100