Merge #433

433: Remove warning on doc compilation r=bidoubiwa a=evpeople

# Pull Request

## Related issue
Fixes #373 

## What does this PR do?
- ...

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: evpeople <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: 3 people

src/dumps.rs

@@ -6,7 +6,7 @@
 //!
 //! During a [dump export](Client::create_dump), all [indexes](crate::indexes::Index) of the current instance are exported—together with their documents and settings—and saved as a single `.dump` file.
 //!
-//! During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated [documents](crate::document::Document) and [settings](crate::settings::Settings).
+//! During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated [documents](crate::documents::Document) and [settings](crate::settings::Settings).
 //! Any existing [index](crate::indexes::Index) with the same uid as an index in the dump file will be overwritten.
 //!
 //! Dump imports are [performed at launch](https://docs.meilisearch.com/reference/features/configuration.html#import-dump) using an option.

src/indexes.rs

@@ -11,7 +11,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
 use std::{collections::HashMap, fmt::Display, time::Duration};
 use time::OffsetDateTime;
 
-/// An index containing [Document]s.
+/// A Meilisearch [index](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
 ///
 /// # Example
 ///
@@ -271,7 +271,7 @@ impl Index {
         SearchQuery::new(self)
     }
 
-    /// Get one [Document] using its unique id.
+    /// Get one document using its unique id.
     /// Serde is needed. Add `serde = {version="1.0", features=["derive"]}` in the dependencies section of your Cargo.toml.
     ///
     /// # Example
@@ -377,7 +377,7 @@ impl Index {
         .await
     }
 
-    /// Get [Document]s by batch.
+    /// Get documents by batch.
     ///
     /// # Example
     ///
@@ -425,7 +425,7 @@ impl Index {
         .await
     }
 
-    /// Get [Document]s by batch with parameters.
+    /// Get documents by batch with parameters.
     /// ```
     /// use serde::{Serialize, Deserialize};
     ///
@@ -480,7 +480,7 @@ impl Index {
         .await
     }
 
-    /// Add a list of [Document]s or replace them if they already exist.
+    /// Add a list of documents or replace them if they already exist.
     ///
     /// If you send an already existing document (same id) the **whole existing document** will be overwritten by the new document.
     /// Fields previously in the document not present in the new document are removed.

src/key.rs

@@ -5,7 +5,7 @@ use crate::{client::Client, errors::Error};
 
 /// Represent a [meilisearch key](https://docs.meilisearch.com/reference/api/keys.html#returned-fields)
 /// You can get a [Key] from the [Client::get_key] method.
-/// Or you can create a [Key] with the [KeyBuilder::create] or [Client::create_key] methods.
+/// Or you can create a [Key] with the [KeyBuilder::new] or [Client::create_key] methods.
 #[derive(Debug, Serialize, Deserialize, Clone)]
 #[serde(rename_all = "camelCase")]
 pub struct Key {

src/lib.rs

@@ -227,7 +227,7 @@
 pub mod client;
 /// Module representing the [documents] structures.
 pub mod documents;
-/// Module containing the [document::Document] trait.
+/// Module containing the [dumps] trait.
 pub mod dumps;
 /// Module containing the [errors::Error] struct.
 pub mod errors;