Skip to content

docs(graph): fix stale MemoryError::NotFound link in add_relation#23

Merged
raymondj99 merged 1 commit into
mainfrom
fix/rustdoc-link
May 18, 2026
Merged

docs(graph): fix stale MemoryError::NotFound link in add_relation#23
raymondj99 merged 1 commit into
mainfrom
fix/rustdoc-link

Conversation

@raymondj99
Copy link
Copy Markdown
Owner

@raymondj99 raymondj99 commented May 18, 2026

Fixes the failing rustdoc CI job on main after v0.4.0 (#22). The add_relation docstring referenced MemoryError::NotFound, a non-existent variant. The real variant is MemoryError::EntityNotFound — caught in the implementation, missed in the docs.

cargo doc --workspace --no-deps and cargo doc --workspace --no-deps --all-features both clean locally after this one-character fix.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified documentation for relation addition functionality to accurately reflect the error type returned when unknown entity identifiers are encountered.

Review Change Stack

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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

Warning

.coderabbit.yaml has a parsing error

The CodeRabbit configuration file in this repository has a parsing error and default settings were used instead. Please fix the error(s) in the configuration file. You can initialize chat with CodeRabbit to get help with the configuration file.

💥 Parsing errors (1)
Validation error: String must contain at most 250 character(s) at "tone_instructions"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: dd13b53f-7d26-47a2-8843-d867a5f2fb69

📥 Commits

Reviewing files that changed from the base of the PR and between 76884c9 and fb5e649.

📒 Files selected for processing (1)
  • crates/openmemory-graph/src/store.rs

📝 Walkthrough

Walkthrough

This PR corrects the documentation for MemoryStore::add_relation to accurately reflect the actual error type returned when entity IDs are not found. The doc comment now specifies MemoryError::EntityNotFound instead of MemoryError::NotFound.

Changes

Error documentation correction

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.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented May 18, 2026

Merging this PR will not alter performance

✅ 19 untouched benchmarks


Comparing fix/rustdoc-link (fb5e649) with main (76884c9)

Open in CodSpeed

@raymondj99 raymondj99 merged commit 5039247 into main May 18, 2026
14 checks passed
@raymondj99 raymondj99 deleted the fix/rustdoc-link branch May 18, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant