matrix-org/synapse

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

Aberta

#10.687 aberto em 24 de ago. de 2021

Ver no GitHubGuia do colaborador
 (9 comentários) (0 reação) (0 responsável)Python (2.196 forks)batch import
S-TolerableT-Enhancementgood first issue

Métricas do repositório

Stars
 (11.713 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 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.

Guia do colaborador

Direção de pesquisa
Familiarize se com a estrutura de documentação e a configuração do Sphinx do projeto Synapse. Em seguida, documente o método `get userinfo by id` na classe ModuleApi adicionando um docstring ou arquivo RST conforme apropriado.
Pilha de tecnologia
python
Domain
backendapi
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinxGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75