Clarify MemoryClient deprecation status - documentation inconsistency

Abierto
#242 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python

Línea de trabajo

Empieza comparando las tres referencias a MemoryClient en src/bedrock_agentcore/memory/README.md con MemoryClient.init() en src/bedrock_agentcore/memory/client.py. Revisa las tres opciones propuestas y confirma la política de desuso prevista con un maintainer antes de editar. La tarea estará terminada cuando la documentación y cualquier comportamiento de advertencia aprobado describan de forma coherente el estado de MemoryClient.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
Python
Estrellas
786
Forks
163
Merge medio
4 h
PR fusionados (30 d)
22

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aws/bedrock-agentcore-sdk-python

Todos los issues de aws/bedrock-agentcore-sdk-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.