Skip to content

Commit

Permalink
Update to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
leontoeides committed Sep 23, 2023
1 parent c5f56bb commit fbc512f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,10 @@
//! `SearchIndex` as you insert into your collection (Vec, HashMap, etc.)
//!
//! It's recommended to wrap your target collection (your `Vec`, `HashMap`,
//! etc.) and this `SearchIndex` together in a new `struct` type. Then,
//! implement the `insert`, `replace`, `remove`, etc. methods for this new
//! etc.) and this `SearchIndex` together in a new `struct` type. (This is
//! called the
//! (Newtype pattern)[https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction].)
//! Then, implement the `insert`, `replace`, `remove`, etc. methods for this new
//! `struct` type that will update both the collection and search index. This
//! will ensure that both your collection and index are always synchronized.
//!
Expand Down

0 comments on commit fbc512f

Please sign in to comment.