matrix-org/synapse

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

Ouverte

#10 687 ouverte le 24 août 2021

Voir sur GitHubGuide contributeur
 (9 commentaires) (0 réaction) (0 personne assignée)Python (2 196 forks)batch import
S-TolerableT-Enhancementgood first issue

Métriques du dépôt

Stars
 (11 713 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Familiarisez vous avec la structure de documentation et la configuration Sphinx du projet Synapse. Ensuite, documentez la méthode `get userinfo by id` dans la classe ModuleApi en ajoutant un docstring ou un fichier RST selon le cas.
Stack technique
python
Domaine
backendapi
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinxGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75