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

Move MatrixClient._sync method to MatrixClient.sync

オープン
#192 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

architecture breaking Client layer enhancement
主要言語
Python
スター
266
フォーク
118
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず #173 の議論を確認し、その後 MatrixClient._sync と listen_for_events を特定してください。_sync を sync に名前変更する前に長期的な公開シグネチャを明確にし、それを文書化して listen_for_events を非推奨にしてください。4つのチェックリスト項目すべてが解決されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
リファクタリング
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。