Clarify MemoryClient deprecation status - documentation inconsistency

Aperta
#242 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia confrontando i tre riferimenti a MemoryClient in src/bedrock_agentcore/memory/README.md con MemoryClient.init() in src/bedrock_agentcore/memory/client.py. Esamina le tre opzioni proposte e conferma la policy di deprecazione prevista con un maintainer prima di modificare il codice. Il lavoro è completato quando la documentazione e qualsiasi comportamento di avviso approvato descrivono in modo coerente lo stato di MemoryClient.

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

Descrizione

Summary

The documentation for MemoryClient has inconsistent messaging about its status:

  1. src/bedrock_agentcore/memory/README.md#L39: "MemoryClient - Legacy client interface (still supported but not recommended for new projects)"
  2. src/bedrock_agentcore/memory/README.md#L120: "While still supported, we recommend migrating to MemorySessionManager for new projects"
  3. 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 DeprecationWarning to MemoryClient.__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
Lingua principale
Python
Stelle
786
Fork
163
Merge medio
4h
PR unite (30g)
22

Preparare l'ambiente

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.

Altre issue di aws/bedrock-agentcore-sdk-python

Tutte le issue di aws/bedrock-agentcore-sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.