Skip to content

Commit e2c56d1

Browse files
committed
docs(rust): update documentation comments
- Simplify description in Engine::query_streaming to use "receiver that yields retrieval events" instead of detailed type reference - Update error module documentation to use proper rustdoc syntax with `[@enum@Error]` for better documentation generation
1 parent 2d54c39 commit e2c56d1

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

rust/src/client/engine.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -485,7 +485,7 @@ impl Engine {
485485

486486
/// Query a document with streaming results.
487487
///
488-
/// Returns a [`RetrieveEventReceiver`] that yields [`RetrieveEvent`](crate::retrieval::RetrieveEvent)s
488+
/// Returns a receiver that yields retrieval events
489489
/// as the retrieval pipeline progresses through each stage.
490490
///
491491
/// Only supports single-document scope (via `with_doc_ids` with one ID).

rust/src/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
//! Error types for the vectorless library.
55
//!
66
//! This module provides a comprehensive error type hierarchy for all operations.
7-
//! All errors are consolidated into [`Error`] with specific variants for each category.
7+
//! All errors are consolidated into [`enum@Error`] with specific variants for each category.
88
99
use thiserror::Error;
1010

0 commit comments

Comments
 (0)