docs: fix type preservation claims in comparison.md

[27Bslash6]

Summary

Update comparison.md to reflect that L1-only mode (backend=None) now preserves Python types after #73/#117.

Three claims corrected:

• Feature comparison note: tuples/sets preserved in L1-only, only converted with distributed backends
• Single-process section: removed incorrect "tradeoff" note about serialization
• Validation evidence: updated to reflect L1-only stores raw objects

Closes #74

Summary by CodeRabbit

• Documentation
  • Clarified type preservation behavior between single-process and distributed cache modes.
  • Updated documentation to specify that single-process mode preserves Python types without serialization overhead.
  • Added guidance on configuring serialization options for type preservation with distributed backends.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 68840204-403a-42f5-a30f-1b8b59f8812f

📥 Commits

Reviewing files that changed from the base of the PR and between 1fc506b and cac53a1.

📒 Files selected for processing (1)

• docs/comparison.md

---

📝 Walkthrough

Walkthrough

This PR updates docs/comparison.md to correct claims about type preservation. It clarifies that L1-only mode preserves raw Python types without serialization, while distributed backends serialize via MessagePack and convert tuples/frozensets to lists by default unless serializer='auto' is configured. Three related sections of the documentation are updated consistently.

Changes

Type Preservation Documentation

Layer / File(s)

Summary

Type preservation clarification across three sections docs/comparison.md

Updated the "Type preservation" section to distinguish L1-only (backend=None) type preservation from distributed-backend serialization behavior; replaced the single-process "tradeoff" text with a "Type safe" statement emphasizing raw object storage; and adjusted the validation evidence bullet to specify that L1-only preserves all Python types while distributed backends serialize (tuples→lists) unless serializer='auto' is configured.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• cachekit-io/cachekit-py#117: Implements the code-level change that preserves raw Python types in L1-only mode while distributed backends serialize, aligning the documentation corrections with the actual behavior.

Poem

🐰 A rabbit hops through docs with glee,
Type preservation now rings true and free!
L1 keeps objects raw and whole,
While distant backends play their role. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The PR addresses issue #74 by correcting documentation to reflect actual L1-only type preservation behavior after changes in #73/#117, directly resolving the identified type preservation claims.	The PR updates documentation to claim L1 preserves types, but issue #74 evidence shows L1 serializes and converts types. Align changes with actual behavior demonstrated in tests/competitive/test_head_to_head.py.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and specifically describes the main change: fixing incorrect claims about type preservation in comparison.md documentation.
Description check	✅ Passed	The description covers the main changes, motivation (closing #74), and the three specific claims being corrected, but lacks detail on some template sections like testing and backward compatibility.
Out of Scope Changes check	✅ Passed	All changes are focused on correcting type preservation claims in comparison.md, directly addressing the three issues identified in #74 without introducing unrelated modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/fix-comparison-type-claims

---

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!