matrix-org / matrix-org/matrix-python-sdk
Move MatrixClient._sync method to MatrixClient.sync
Ouverte
Personne n'a encore pris cette issue.
architecture
breaking
Client layer
enhancement
- Langage dominant
- Python
- Étoiles
- 266
- Forks
- 118
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
- Docstring for
_syncneeds to be written. - Make sure the
_syncmethod signature is what we want to expose to users
long-term. - Rename
_synctosync. - Deprecate
listen_for_events.
Some discussion of this plan on #173.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez d’abord la discussion dans #173, puis localisez MatrixClient._sync et listen_for_events. Clarifiez la signature publique à long terme avant de renommer _sync en sync, documentez-la et dépréciez listen_for_events ; cela est terminé lorsque les quatre éléments de la checklist sont résolus.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- api
- Type d'issue
- Refactorisation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100