Clarify MemoryClient deprecation status - documentation inconsistency

Aberta
#242 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Comece comparando as três referências a MemoryClient em src/bedrock_agentcore/memory/README.md com MemoryClient.init() em src/bedrock_agentcore/memory/client.py. Analise as três opções propostas e confirme a política de descontinuação pretendida com um maintainer antes de editar. O trabalho estará concluído quando a documentação e qualquer comportamento de aviso aprovado descreverem de forma consistente o status de MemoryClient.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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
Linguagem predominante
Python
Estrelas
786
Forks
163
Merge médio
4h
PRs com merge (30d)
22

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de aws/bedrock-agentcore-sdk-python

Todas as issues de aws/bedrock-agentcore-sdk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.