matrix-org / matrix-org/matrix-python-sdk
Move MatrixClient._sync method to MatrixClient.sync
Open
Nobody has claimed this yet.
architecture
breaking
Client layer
enhancement
- Dominant language
- Python
- Stars
- 266
- Forks
- 118
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the discussion on #173 first, then locate MatrixClient._sync and listen_for_events. Clarify the long-term public signature before renaming _sync to sync, document it, and deprecate listen_for_events; done means all four checklist items are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100