Skip to content

Commit

Permalink
Improve docs in index::id_map
Browse files Browse the repository at this point in the history
  • Loading branch information
Enet4 committed Jun 13, 2018
1 parent df249ff commit dbd26c9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/index/id_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
//! time properties of the index type `I`, while ensuring the extra ID mapping
//! functionality.
//!
//! [`Index#add_with_ids`]: ../trait.Index.html#tymethod.add_with_ids
//! [Faiss wiki]: https://github.com/facebookresearch/faiss/wiki/Pre--and-post-processing#faiss-id-mapping
//! [`Index#add_with_id`]: ../trait.Index.html#add_with_ids
//! [`IdMap`]: struct.IdMap.html
//!
//! # Examples
Expand All @@ -36,11 +36,11 @@
//! in CPU memory. Once an index map is made, moving an index to/from the GPU
//! is not possible.
//!
//! ```
//! # #[cfg(feature = "gpu")]
//! # use faiss::{GpuResources, StandardGpuResources, Index, FlatIndex, IdMap};
//! # #[cfg(feature = "gpu")]
//! # use faiss::error::Result;
//!
//! # #[cfg(feature = "gpu")]
//! # fn run() -> Result<()> {
//! let index = FlatIndex::new_l2(8)?;
Expand Down Expand Up @@ -68,7 +68,7 @@ use std::ptr;
///
/// See the [module level documentation] for more information.
///
/// [module level documentation](./index.html)
/// [module level documentation]: ./index.html
#[derive(Debug)]
pub struct IdMap<I> {
inner: *mut FaissIndexIDMap,
Expand Down

0 comments on commit dbd26c9

Please sign in to comment.