Clarify MemoryClient deprecation status - documentation inconsistency
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
まず、src/bedrock_agentcore/memory/README.md にある MemoryClient への3つの参照を、src/bedrock_agentcore/memory/client.py の MemoryClient.init() と比較します。編集する前に、提案されている3つの選択肢を確認し、意図された非推奨化ポリシーを maintainer と確認します。ドキュメントと承認された警告動作が MemoryClient の状態を一貫して説明していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
The documentation for MemoryClient has inconsistent messaging about its status:
src/bedrock_agentcore/memory/README.md#L39: "MemoryClient - Legacy client interface (still supported but not recommended for new projects)"src/bedrock_agentcore/memory/README.md#L120: "While still supported, we recommend migrating to MemorySessionManager for new projects"src/bedrock_agentcore/memory/README.md#L555: "MemoryClient: Legacy client interface (deprecated)"
The first two say "still supported" while the third says "deprecated". Additionally, there's no actual DeprecationWarning in the code when users instantiate MemoryClient.
Proposed Options
Option A: Formally deprecate MemoryClient
- Add
DeprecationWarningtoMemoryClient.__init__() - Update all documentation to consistently say "deprecated"
- Set a target removal version (e.g., v2.0.0)
Option B: Keep as "legacy" without formal deprecation
- Remove "deprecated" from API Reference section
- Keep "legacy" and "not recommended" language
- No code changes needed
Option C: Staged approach
- Fix documentation to be consistent ("legacy, not recommended")
- Add deprecation warning in a future minor release
- Remove in a future major release
- 主要言語
- Python
- スター
- 786
- フォーク
- 163
- 平均マージ
- 4時間
- マージ済み PR(30日)
- 22
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aws/bedrock-agentcore-sdk-python のほかの issue
-
bug high-severity
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
aws/bedrock-agentcore-sdk-python#752 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
aws/bedrock-agentcore-sdk-python#751 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
delete_all_long_term_memories_in_namespace deletes only the first 10 records対応中かも @Fire162 が 18 日前に担当しました。 オープンbug high-severity
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
aws/bedrock-agentcore-sdk-python#727 ·
メンテナーはふだん 1 日以内に返信
-
MPP: credential is always sent in Authorization, ignoring header="Payment-Authorization" in the challenge対応中かも @abhiramshaji-cyber が 24 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
aws/bedrock-agentcore-sdk-python#702 ·
メンテナーはふだん 1 日以内に返信
-
[Bug] update_message fails with parameter validation error when SessionMessage.message_id is a Strands positional integer index対応中かも @citizen204 が 144 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
aws/bedrock-agentcore-sdk-python#556 ·
メンテナーはふだん 1 日以内に返信
aws/bedrock-agentcore-sdk-python の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
snap-stanford/Biomni#380 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
microsoft/playwright-python#3361 ·
メンテナーはふだん 1 日以内に返信
-
documentation priority: low size: S status: needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
cubrid-lab/sqlalchemy-cubrid#1397 ·
メンテナーはふだん 1 日以内に返信
-
documentation priority: low size: S status: needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
cubrid-lab/pycubrid#1307 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: Installer hides SSL certificate errors as bare URLError, and the suggested fix can't workオープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
ShaftHQ/chaosengine-harness#143 ·
メンテナーはふだん 1 日以内に返信