matrix-org / matrix-org/matrix-python-sdk

Move MatrixClient._sync method to MatrixClient.sync

Offen
#192 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

architecture breaking Client layer enhancement
Vorherrschende Sprache
Python
Sterne
266
Forks
118
Keine gemergten PRs in 30 T.

Beschreibung

  • Docstring for _sync needs to be written.
  • Make sure the _sync method signature is what we want to expose to users
    long-term.
  • Rename _sync to sync.
  • Deprecate listen_for_events.

Some discussion of this plan on #173.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Prüfe zuerst die Diskussion in #173 und ermittle dann MatrixClient._sync und listen_for_events. Kläre die langfristige öffentliche Signatur, bevor du _sync in sync umbenennst, dokumentiere sie und markiere listen_for_events als veraltet; erledigt bedeutet, dass alle vier Checklistenpunkte geklärt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api
Issue-Typ
Refactoring
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.