[DOCS] Broken Keyword Argument Support: Parameter Name Mismatch in Python SDK Docs

Resolved 💬 4 comments Opened Jan 21, 2026 by coygeek Closed Feb 27, 2026

Documentation Type

Unclear/confusing documentation

Documentation Location

https://platform.claude.com/docs/en/agent-sdk/python

Section/Topic

The Classes section for ClaudeSDKClient, specifically the definition block and the Methods table entry for rewind_files.

Current Documentation

In the Python class definition block:

async def rewind_files(self, user_message_uuid: str) -> None

In the Methods table:
| Method | Description |
| :--- | :--- |
| rewind_files(user_message_uuid) | Restore files to their state at the specified user message... |

What's Wrong or Missing?

The parameter name listed in the documentation is user_message_uuid, but the actual source code definition in src/claude_agent_sdk/client.py uses user_message_id.

If a user tries to call this method using keyword arguments based on the documentation (e.g., client.rewind_files(user_message_uuid="...")), it will raise a TypeError: rewind_files() got an unexpected keyword argument 'user_message_uuid'.

Suggested Improvement

Update the parameter name to user_message_id to match the source code implementation.

Class definition update:

async def rewind_files(self, user_message_id: str) -> None

Table update:
| rewind_files(user_message_id) | Restore files to their state at the specified user message... |

Impact

High - Prevents users from using a feature

Additional Context

  • Source Code Reference: src/claude_agent_sdk/client.py

``python
async def rewind_files(self, user_message_id: str) -> None:
"""Rewind tracked files to their state at a specific user message.
...
``

  • This affects users attempting to use explicit keyword arguments for clarity or safety.

View original on GitHub ↗

This issue has 4 comments on GitHub. Read the full discussion on GitHub ↗