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

Repository metrics

Stars
 (11,713 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Familiarize yourself with the Synapse project's documentation structure and Sphinx configuration. Then document the `get userinfo by id` method in the ModuleApi class by adding a docstring or RST file as appropriate.
Tech stack
python
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinxGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75