matrix-org/synapse

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

Offen

#10.687 geöffnet am 24.08.2021

Auf GitHub ansehenContributor Guide
 (9 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (2.196 Forks)batch import
S-TolerableT-Enhancementgood first issue

Repository-Metriken

Stars
 (11.713 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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-Richtung
Machen Sie sich mit der Dokumentationsstruktur und der Sphinx Konfiguration des Synapse Projekts vertraut. Dokumentieren Sie dann die Methode `get userinfo by id` in der Klasse ModuleApi, indem Sie je nach Bedarf einen Docstring oder eine RST Datei hinzufügen.
Tech Stack
python
Domain
backendapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinxGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75