diff --git a/columnar/src/column_values/mod.rs b/columnar/src/column_values/mod.rs index 42cf796b0..f2e1b036a 100644 --- a/columnar/src/column_values/mod.rs +++ b/columnar/src/column_values/mod.rs @@ -2,7 +2,7 @@ //! # `fastfield_codecs` //! -//! - Columnar storage of data for tantivy [`Column`]. +//! - Columnar storage of data for tantivy [`crate::Column`]. //! - Encode data in different codecs. //! - Monotonically map values to u64/u128 diff --git a/columnar/src/columnar/merge/merge_mapping.rs b/columnar/src/columnar/merge/merge_mapping.rs index e4b5be628..842886182 100644 --- a/columnar/src/columnar/merge/merge_mapping.rs +++ b/columnar/src/columnar/merge/merge_mapping.rs @@ -52,8 +52,8 @@ pub enum MergeRowOrder { /// Columnar tables are simply stacked one above the other. /// If the i-th columnar_readers has n_rows_i rows, then /// in the resulting columnar, - /// rows [r0..n_row_0) contains the row of columnar_readers[0], in ordder - /// rows [n_row_0..n_row_0 + n_row_1 contains the row of columnar_readers[1], in order. + /// rows [r0..n_row_0) contains the row of `columnar_readers[0]`, in ordder + /// rows [n_row_0..n_row_0 + n_row_1 contains the row of `columnar_readers[1]`, in order. /// .. /// No documents is deleted. Stack(StackMergeOrder), diff --git a/src/aggregation/bucket/mod.rs b/src/aggregation/bucket/mod.rs index 711b6c2f3..0c1b90dbc 100644 --- a/src/aggregation/bucket/mod.rs +++ b/src/aggregation/bucket/mod.rs @@ -15,6 +15,12 @@ //! Results of final buckets are [`BucketResult`](super::agg_result::BucketResult). //! Results of intermediate buckets are //! [`IntermediateBucketResult`](super::intermediate_agg_result::IntermediateBucketResult) +//! +//! ## Supported Bucket Aggregations +//! - [Histogram](HistogramAggregation) +//! - [DateHistogram](DateHistogramAggregationReq) +//! - [Range](RangeAggregation) +//! - [Terms](TermsAggregation) mod histogram; mod range; diff --git a/src/aggregation/metric/mod.rs b/src/aggregation/metric/mod.rs index 50ff0389f..c894dead5 100644 --- a/src/aggregation/metric/mod.rs +++ b/src/aggregation/metric/mod.rs @@ -6,6 +6,15 @@ //! Some aggregations output a single numeric metric (e.g. Average) and are called //! single-value numeric metrics aggregation, others generate multiple metrics (e.g. Stats) and are //! called multi-value numeric metrics aggregation. +//! +//! ## Supported Metric Aggregations +//! - [Average](AverageAggregation) +//! - [Stats](StatsAggregation) +//! - [Min](MinAggregation) +//! - [Max](MaxAggregation) +//! - [Sum](SumAggregation) +//! - [Count](CountAggregation) +//! - [Percentiles](PercentilesAggregationReq) mod average; mod count; diff --git a/src/core/json_utils.rs b/src/core/json_utils.rs index a02d86293..25dff1dde 100644 --- a/src/core/json_utils.rs +++ b/src/core/json_utils.rs @@ -259,7 +259,7 @@ pub(crate) fn set_string_and_get_terms( /// Writes a value of a JSON field to a `Term`. /// The Term format is as follows: -/// [JSON_TYPE][JSON_PATH][JSON_END_OF_PATH][VALUE_BYTES] +/// `[JSON_TYPE][JSON_PATH][JSON_END_OF_PATH][VALUE_BYTES]` pub struct JsonTermWriter<'a> { term_buffer: &'a mut Term, path_stack: Vec,