aws / aws/bedrock-agentcore-sdk-python

Clarify MemoryClient deprecation status - documentation inconsistency

Abierto
#242 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Python
Estrellas
761
Forks
147
Merge medio
1 d 23 h
PR fusionados (30 d)
7

Descripción

## Summary

The documentation for `MemoryClient` has inconsistent messaging about its status:

1. [`src/bedrock_agentcore/memory/README.md#L39`](https://github.com/aws/bedrock-agentcore-sdk-python/blob/main/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`](https://github.com/aws/bedrock-agentcore-sdk-python/blob/main/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`](https://github.com/aws/bedrock-agentcore-sdk-python/blob/main/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`](https://github.com/aws/bedrock-agentcore-sdk-python/blob/main/src/bedrock_agentcore/memory/client.py#L43).

## 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

Guía de contribución

Abrir la guía de contribución

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.

Evaluación

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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.