Skip to content

Commit bb8d2ef

Browse files
minor: improve documentation for show_record_id option (#1167)
1 parent 316ea1a commit bb8d2ef

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/coll/options.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -834,7 +834,10 @@ pub struct FindOptions {
834834
#[serde(skip)]
835835
pub selection_criteria: Option<SelectionCriteria>,
836836

837-
/// Whether to return the record identifier for each document.
837+
/// Whether to return the record identifier for each document. If true, adds a `$recordId`
838+
/// field to the returned documents.
839+
///
840+
/// Defaults to false.
838841
pub show_record_id: Option<bool>,
839842

840843
/// The number of documents to skip before counting.

0 commit comments

Comments
 (0)