Skip to content

Add AsyncKeyValue protocol to protocols.md #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GGOemea wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add AsyncKeyValue protocol to protocols.md #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/api/protocols.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ composability.
show_source: true
members: true
show_root_heading: true
class AsyncKeyValue(AsyncKeyValueProtocol, Protocol):

@cubic-dev-ai cubic-dev-ai Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

"""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.
"""
Comment on lines +14 to +19

@coderabbitai coderabbitai Bot Jul 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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.