Attempt to fix doc

quickwit/quickwit-indexing/src/source/mod.rs

@@ -200,16 +200,16 @@ pub type SourceContext = ActorContext<SourceActor>;
 /// as follow:
 ///
 /// ```ignore
-/// # fn whatever() -> anyhow::Result<()>
-/// source.initialize(ctx)?;
-/// let exit_status = loop {
-///   if let Err(exit_status) = source.emit_batches()? {
-///      break exit_status;
-///  }
-/// };
-/// source.finalize(exit_status)?;
-/// # Ok(())
-/// # }
+/// fn whatever() -> anyhow::Result<()> {
+///     source.initialize(ctx)?;
+///     let exit_status = loop {
+///         if let Err(exit_status) = source.emit_batches()? {
+///             break exit_status;
+///         }
+///     };
+///     source.finalize(exit_status)?;
+///     Ok(())
+/// }
 /// ```
 #[async_trait]
 pub trait Source: Send + 'static {

quickwit/quickwit-janitor/src/actors/delete_task_planner.rs

@@ -341,8 +341,8 @@ impl DeleteTaskPlanner {
         Ok(false)
     }
 
-    /// Fetches stale splits from [`Metastore`] and excludes immature splits and split already among
-    /// ongoing delete operations.
+    /// Fetches stale splits from [`quickwit_metastore::Metastore`] and excludes immature splits and
+    /// split already among ongoing delete operations.
     async fn get_relevant_stale_splits(
         &mut self,
         index_uid: IndexUid,

quickwit/quickwit-query/src/elastic_query_dsl/string_or_struct.rs

@@ -35,7 +35,7 @@ use serde::{de, Deserialize, Deserializer};
 ///
 /// We don't use untagged enum to support this, in order to keep good errors.
 ///
-/// The code below is adapted from solution described here: https://serde.rs/string-or-struct.html
+/// The code below is adapted from solution described here: <https://serde.rs/string-or-struct.html>
 #[derive(Deserialize)]
 #[serde(transparent)]
 pub(crate) struct StringOrStructForSerialization<T>

quickwit/quickwit-search/src/list_fields.rs

@@ -164,7 +164,7 @@ fn merge_same_field_group(
     }
 }
 
-/// Merge iterators of ListFieldsEntryResponse into a Vec<ListFieldsEntryResponse>.
+/// Merge iterators of ListFieldsEntryResponse into a `Vec<ListFieldsEntryResponse>`.
 ///
 /// The iterators need to be sorted by (field_name, fieldtype)
 fn merge_leaf_list_fields(

quickwit/quickwit-search/src/list_fields_cache.rs

@@ -53,7 +53,7 @@ impl ListFieldsCache {
     }
 }
 
-/// A key inside a [`LeafSearchCache`].
+/// A key inside a [`ListFieldsCache`].
 #[derive(Debug, Hash, PartialEq, Eq)]
 struct CacheKey {
     /// The split this entry refers to

quickwit/quickwit-search/src/list_terms.rs

@@ -176,7 +176,7 @@ pub async fn root_list_terms(
     })
 }
 
-/// Builds a list of [`LeafListFieldsRequest`], one per index, from a list of [`SearchJob`].
+/// Builds a list of [`LeafListTermsRequest`], one per index, from a list of [`SearchJob`].
 pub fn jobs_to_leaf_requests(
     request: &ListTermsRequest,
     index_uid_to_uri: &HashMap<IndexUid, String>,

quickwit/quickwit-serve/src/jaeger_api/model.rs

@@ -93,7 +93,7 @@ impl JaegerTrace {
     /// `service_name` values. The function uses an accumulator (`acc`) to keep track of
     /// processed `JaegerProcess` objects and assigns a new key to each unique `service_name` value.
     /// The logic has been replicated from
-    /// https://github.com/jaegertracing/jaeger/blob/995231c42cadd70bce2bbbf02579e33f6e6329c8/model/converter/json/process_hashtable.go#L37
+    /// <https://github.com/jaegertracing/jaeger/blob/995231c42cadd70bce2bbbf02579e33f6e6329c8/model/converter/json/process_hashtable.go#L37>
     /// TODO: use also tags to identify processes.
     fn build_process_map(spans: &mut [JaegerSpan]) -> HashMap<String, JaegerProcess> {
         let mut service_name_to_process_id: HashMap<String, String> = HashMap::new();

quickwit/quickwit-serve/src/rest_api_response.rs

@@ -50,7 +50,7 @@ impl ToString for RestApiError {
 }
 
 /// Makes a JSON API response from a result.
-/// The error is wrapped into an [`ApiError`] to publicly expose
+/// The error is wrapped into an [`RestApiError`] to publicly expose
 /// a consistent error format.
 pub(crate) fn into_rest_api_response<T: serde::Serialize, E: ServiceError>(
     result: Result<T, E>,