Add AsyncKeyValue protocol to protocols.md#364
Conversation
Added AsyncKeyValue protocol for key-value store operations including basic and bulk operations.
WalkthroughThis change updates the API documentation file docs/api/protocols.md to add a documented class signature for the AsyncKeyValue protocol, showing it as inheriting from AsyncKeyValueProtocol and Protocol, along with a docstring listing its basic operations (get, put, delete, ttl) and bulk operations (get_many, put_many, delete_many, ttl_many). Changes
Related issues: None specified. Related PRs: None specified. Suggested labels: documentation Suggested reviewers: strawgate PoemA rabbit hopped through docs today, 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/api/protocols.md`:
- Around line 14-19: Remove the manually pasted source block for AsyncKeyValue
in the protocol docs and rely on the mkdocstrings ::: autogen output instead.
Keep the documented class via the existing directive and delete the duplicated
raw class/source lines so the rendered docs come only from autogen; if the
output is missing or incomplete, adjust the mkdocstrings configuration rather
than reintroducing source duplication.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: b0cb549d-67c0-4102-a1be-79d7cfe3127e
📒 Files selected for processing (1)
docs/api/protocols.md
| class AsyncKeyValue(AsyncKeyValueProtocol, Protocol): | ||
| """A protocol for key-value store operations. | ||
|
|
||
| Includes basic operations: get, put, delete, ttl | ||
| Includes bulk operations: get_many, put_many, delete_many, ttl_many. | ||
| """ |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win
Remove manual source duplication; rely on mkdocstrings autogen.
The ::: directive on line 9 with show_source: true and members: true already renders the class signature, docstring, and members. Pasting the raw source here (lines 14-19) duplicates that output and risks stale docs when the source changes.
Either drop lines 14-19 entirely, or if the autogen output isn't rendering correctly, fix the mkdocstrings configuration rather than manually duplicating source.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/api/protocols.md` around lines 14 - 19, Remove the manually pasted
source block for AsyncKeyValue in the protocol docs and rely on the mkdocstrings
::: autogen output instead. Keep the documented class via the existing directive
and delete the duplicated raw class/source lines so the rendered docs come only
from autogen; if the output is missing or incomplete, adjust the mkdocstrings
configuration rather than reintroducing source duplication.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/api/protocols.md">
<violation number="1" location="docs/api/protocols.md:14">
P1: Custom agent flagged.
Raw Python class definition pasted into markdown without code fences as duplicated filler/AI slop inside an mkdocstrings options block.</violation>
</file>
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
| show_source: true | ||
| members: true | ||
| show_root_heading: true | ||
| class AsyncKeyValue(AsyncKeyValueProtocol, Protocol): |
There was a problem hiding this comment.
P1: Custom agent flagged.
Raw Python class definition pasted into markdown without code fences as duplicated filler/AI slop inside an mkdocstrings options block.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/api/protocols.md, line 14:
<comment>Raw Python class definition pasted into markdown without code fences as duplicated filler/AI slop inside an mkdocstrings options block.</comment>
<file context>
@@ -11,3 +11,9 @@ composability.
show_source: true
members: true
show_root_heading: true
+ class AsyncKeyValue(AsyncKeyValueProtocol, Protocol):
+ """A protocol for key-value store operations.
+
</file context>
1 participant
Added AsyncKeyValue protocol for key-value store operations including basic and bulk operations.