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

Move MatrixClient._sync method to MatrixClient.sync

Aperta
#192 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

architecture breaking Client layer enhancement
Lingua principale
Python
Stelle
266
Fork
118
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

  • 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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina prima la discussione in #173, quindi individua MatrixClient._sync e listen_for_events. Chiarisci la firma pubblica a lungo termine prima di rinominare _sync in sync, documentala e depreca listen_for_events; il lavoro è completato quando tutti e quattro gli elementi della checklist sono risolti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Refactoring
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.