From 1232af79287d0de3b91acf8ceb89ac279ba89b26 Mon Sep 17 00:00:00 2001 From: PSeitz Date: Mon, 21 Feb 2022 15:15:58 +0100 Subject: [PATCH] fix docs (#1288) --- src/aggregation/bucket/mod.rs | 4 ++-- src/aggregation/bucket/range.rs | 4 ++-- src/reader/mod.rs | 2 +- src/reader/warming.rs | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/aggregation/bucket/mod.rs b/src/aggregation/bucket/mod.rs index 22ceea0aa..ac97393f9 100644 --- a/src/aggregation/bucket/mod.rs +++ b/src/aggregation/bucket/mod.rs @@ -1,8 +1,8 @@ //! Module for all bucket aggregations. //! -//! Results of final buckets are [BucketEntry](super::agg_result::BucketEntry). +//! Results of final buckets are [BucketResult](super::agg_result::BucketResult). //! Results of intermediate buckets are -//! [IntermediateBucketEntry](super::intermediate_agg_result::IntermediateBucketEntry) +//! [IntermediateBucketResult](super::intermediate_agg_result::IntermediateBucketResult) mod range; diff --git a/src/aggregation/bucket/range.rs b/src/aggregation/bucket/range.rs index e4ff6ee76..4bceb70f4 100644 --- a/src/aggregation/bucket/range.rs +++ b/src/aggregation/bucket/range.rs @@ -23,12 +23,12 @@ use crate::{DocId, TantivyError}; /// to value for each range. /// /// Result type is [BucketResult](crate::aggregation::agg_result::BucketResult) with -/// [BucketEntryKeyCount](crate::aggregation::agg_result::BucketEntryKeyCount) on the +/// [BucketEntryKeyCount](crate::aggregation::agg_result::RangeBucketEntry) on the /// AggregationCollector. /// /// Result type is /// [crate::aggregation::intermediate_agg_result::IntermediateBucketResult] with -/// [crate::aggregation::intermediate_agg_result::IntermediateBucketEntryKeyCount] on the +/// [crate::aggregation::intermediate_agg_result::IntermediateRangeBucketEntry] on the /// DistributedAggregationCollector. #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] pub struct RangeAggregation { diff --git a/src/reader/mod.rs b/src/reader/mod.rs index 07713fac2..a61172d3b 100644 --- a/src/reader/mod.rs +++ b/src/reader/mod.rs @@ -122,7 +122,7 @@ impl IndexReaderBuilder { /// Sets the number of [Searcher] to pool. /// - /// See [Self::searcher()]. + /// See [IndexReader::searcher()]. #[must_use] pub fn num_searchers(mut self, num_searchers: usize) -> IndexReaderBuilder { self.num_searchers = num_searchers; diff --git a/src/reader/warming.rs b/src/reader/warming.rs index f5797cc5f..dcfe95a15 100644 --- a/src/reader/warming.rs +++ b/src/reader/warming.rs @@ -10,7 +10,7 @@ pub const GC_INTERVAL: Duration = Duration::from_secs(1); /// `Warmer` can be used to maintain segment-level state e.g. caches. /// -/// They must be registered with the [IndexReaderBuilder]. +/// They must be registered with the [super::IndexReaderBuilder]. pub trait Warmer: Sync + Send { /// Perform any warming work using the provided [Searcher]. fn warm(&self, searcher: &Searcher) -> crate::Result<()>;