Skip to content

docs(acp): document **_kwargs pattern for protocol compatibility#683

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
fix/code-quality/document-acp-kwargs
Open

docs(acp): document **_kwargs pattern for protocol compatibility#683
github-actions[bot] wants to merge 1 commit into
mainfrom
fix/code-quality/document-acp-kwargs

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Summary

Adds module-level documentation to base_agent.py explaining why ACP agent methods use **_kwargs: Any parameters.

This documentation clarifies that the pattern is intentional for ACP protocol forward compatibility, rather than being a code smell or oversight.

Changes

  • Added detailed module docstring section explaining the **_kwargs pattern
  • Documents three key reasons: protocol evolution, client compatibility, and ABC flexibility

Related Issue

Addresses findings from #681

Testing

  • Linting passes (make lint)
  • All 1308 tests pass (make test)
  • Documentation-only change, no behavior modifications

This PR was automatically generated by the Code Quality Report workflow.

Add module-level documentation explaining why methods in base_agent.py
use **_kwargs: Any parameters. This pattern enables:
- Forward compatibility with future ACP protocol versions
- Graceful handling of parameters from different ACP clients
- Flexibility for subclass implementations

Addresses item from code quality report.

Closes #681

Co-authored-by: openhands <openhands@all-hands.dev>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants