docs(graph): fix stale MemoryError::NotFound link in add_relation#23
Conversation
CI's `cargo doc --workspace --no-deps -D warnings` job rejected the v0.4.0 commit because the `add_relation` docstring referenced `MemoryError::NotFound`, a non-existent variant. The actual variant is `MemoryError::EntityNotFound` — caught in code review when I adjusted the implementation, missed in the docstring. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning
|
| Layer / File(s) | Summary |
|---|---|
add_relation error documentation crates/openmemory-graph/src/store.rs |
Doc comment for MemoryStore::add_relation updated to document MemoryError::EntityNotFound as the error variant for unknown entity IDs. |
Estimated code review effort
🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
A doc needs a fix, just one little line,
EntityNotFound—now the error shines!
No logic was harmed in this change so divine,
Just clarity blooming, documentation so fine. 🐰✨
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | ✅ Passed | Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | ✅ Passed | The title clearly and accurately describes the main change: fixing documentation in the add_relation function by correcting a stale error type reference from MemoryError::NotFound to MemoryError::EntityNotFound. |
| Docstring Coverage | ✅ Passed | Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. |
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
📝 Generate docstrings
- Create stacked PR
- Commit on current branch
🧪 Generate unit tests (beta)
- Create PR with unit tests
- Commit unit tests in branch
fix/rustdoc-link
Comment @coderabbitai help to get the list of available commands and usage tips.
Fixes the failing rustdoc CI job on main after v0.4.0 (#22). The
add_relationdocstring referencedMemoryError::NotFound, a non-existent variant. The real variant isMemoryError::EntityNotFound— caught in the implementation, missed in the docs.cargo doc --workspace --no-depsandcargo doc --workspace --no-deps --all-featuresboth clean locally after this one-character fix.🤖 Generated with Claude Code
Summary by CodeRabbit