matrix-org/synapse

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

Aperta

#10.687 aperta il 24 ago 2021

Vedi su GitHubGuida contributor
 (9 commenti) (0 reazioni) (0 assegnatari)Python (2196 fork)batch import
S-TolerableT-Enhancementgood first issue

Metriche repository

Star
 (11.713 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Familiarizzati con la struttura della documentazione e la configurazione di Sphinx del progetto Synapse. Quindi documenta il metodo `get userinfo by id` nella classe ModuleApi aggiungendo un docstring o un file RST come appropriato.
Tech stack
python
Dominio
backendapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinxGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75