docs: fix documentation issues

[strawgate]

Fixes documentation issues identified in issue #136

Changes

• Fixed variable name bug in README.md line 138 (store → key_value)
• Fixed license statement in README.md line 411 (MIT → Apache 2.0)
• Added missing DefaultValueWrapper to README.md wrappers table
• Added missing TimeoutWrapper to README.md wrappers table
• Added DefaultValue to AGENTS.md wrappers list

Version numbers remain at 0.2.8 as requested.

Generated with Claude Code) | [View job run](https://github.com/strawgate/py-key-value/actions/runs/18826024279

Summary by CodeRabbit

• Documentation
  • Updated example usage in documentation
  • Expanded wrappers reference with new wrapper types
• Chores
  • Updated license to Apache 2.0

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updated to include new wrapper types (DefaultValueWrapper, TimeoutWrapper, and others) in wrappers listings. License header changed from MIT to Apache 2.0. Code example updated to call get method on key_value instance instead of a local store variable.

Changes

Cohort / File(s)	Change Summary
Documentation updates AGENTS.md, README.md	Added DefaultValue and multiple other wrappers to wrappers documentation. Updated code example to call get on key_value instance. Changed license from MIT to Apache 2.0.

Possibly related PRs

• Add AGENTS.md file #130: Adds AGENTS.md file, which is extended in this PR with additional wrapper definitions.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Title Check	❓ Inconclusive	The title "docs: fix documentation issues" is related to the changeset since all modifications are indeed to documentation files. However, the title is overly generic and vague, using the non-descriptive term "issues" without specifying what documentation problems were actually addressed. The PR includes three distinct types of changes: a variable name bug fix, a license statement correction, and additions of missing wrappers to the documentation. A teammate scanning the commit history would know something in docs was fixed, but not what specifically, which fails to meet the requirement of being "clear and specific enough that a teammate scanning history understands the primary change."	Consider revising the title to be more specific about the main changes, such as "docs: fix variable reference, license statement, and add missing wrappers" or splitting the changes if they represent distinct concerns. This would help teammates understand at a glance what documentation issues were addressed without requiring them to examine the PR details.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch claude/issue-136-20251027-0025

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d58fe24 and 08e54eb.

📒 Files selected for processing (2)

• AGENTS.md (1 hunks)
• README.md (4 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

**/*.md: Use Ruff/markdown support and markdownlint for Markdown files per repository configuration
Markdown line length is 80 characters (excluding code blocks and tables)

Files:

• AGENTS.md
• README.md

🧠 Learnings (2)

📚 Learning: 2025-10-26T16:57:34.088Z

Learnt from: CR
PR: strawgate/py-key-value#0
File: AGENTS.md:0-0
Timestamp: 2025-10-26T16:57:34.088Z
Learning: Applies to key-value/key-value-aio/src/key_value/aio/{wrappers,adapters}/**/*.py : Add functionality via wrappers/adapters in their respective directories rather than modifying core store behavior directly

Applied to files:

• AGENTS.md

📚 Learning: 2025-10-26T16:57:34.087Z

Learnt from: CR
PR: strawgate/py-key-value#0
File: AGENTS.md:0-0
Timestamp: 2025-10-26T16:57:34.087Z
Learning: Applies to key-value/key-value-aio/src/key_value/aio/stores/**/*.py : Async store implementations must implement the AsyncKeyValue protocol (key_value/aio/protocols/key_value.py)

Applied to files:

• README.md

🔇 Additional comments (4)

AGENTS.md (1)

176-177: Verify markdown line length compliance.

Line 176 appears to exceed the 80-character limit defined in the coding guidelines. According to markdownlint configuration standards, tables are exempted from line length checks, but regular text lines should comply with the 80-character limit.

Consider breaking the line differently to ensure both lines stay within the limit:

-Wrappers include: Compression, DefaultValue, Encryption, Logging, Statistics,
-Retry, Timeout, Cache, Prefix, TTL clamping, and more.
+Wrappers include: Compression, DefaultValueWrapper, Encryption, Logging,
+Statistics, Retry, Timeout, Cache, Prefix, TTL clamping, and more.

Also note: The wrapper names should use consistent naming (e.g., "DefaultValueWrapper" to match README.md terminology).

README.md (3)

138-138: Good catch on the variable name fix.

This correctly updates the code example to use the parameter name key_value instead of the undefined variable store. The example now properly demonstrates calling get on the store instance passed as an argument.

---

302-302: Wrapper table additions look good.

The new wrapper entries (DefaultValueWrapper, TimeoutWrapper, and TTLClampWrapper) are properly formatted and follow the established pattern:

• Consistent description style
• Practical example instantiation code
• Appropriate alphabetical placement
• Descriptions align with typical wrapper behavior

These entries match the additions documented in AGENTS.md (with naming consistency: "DefaultValue" in AGENTS.md vs "DefaultValueWrapper" in README.md table).

Also applies to: 315-316

---

413-413: License attribution updated correctly.

The license statement has been updated from MIT to Apache 2.0, which aligns with the PR objectives and reflects the correct project license.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud