fix docs

Author: PSeitz

src/aggregation/agg_req.rs

@@ -39,7 +39,7 @@ use super::metric::{
 };
 
 /// The top-level aggregation request structure, which contains [`Aggregation`] and their user
-/// defined names. It is also used in [buckets](BucketAggregation) to define sub-aggregations.
+/// defined names. It is also used in buckets aggregations to define sub-aggregations.
 ///
 /// The key is the user defined name of the aggregation.
 pub type Aggregations = HashMap<String, Aggregation>;

src/aggregation/bucket/mod.rs

@@ -1,7 +1,6 @@
 //! Module for all bucket aggregations.
 //!
-//! BucketAggregations create buckets of documents
-//! [`BucketAggregation`](super::agg_req::BucketAggregation).
+//! BucketAggregations create buckets of documents.
 //! Each bucket is associated with a rule which
 //! determines whether or not a document in the falls into it. In other words, the buckets
 //! effectively define document sets. Buckets are not necessarily disjunct, therefore a document can

src/aggregation/metric/percentiles.rs

@@ -34,7 +34,7 @@ use crate::{DocId, TantivyError};
 /// following example demonstrates a request for the percentiles of the "load_time"
 /// field:
 ///
-/// ```json
+/// ```JSON
 /// {
 ///     "percentiles": {
 ///         "field": "load_time"
@@ -46,7 +46,7 @@ use crate::{DocId, TantivyError};
 /// 25, 50 (median), 75, 95, and 99). You can also customize the percentiles you want to
 /// calculate by providing an array of values in the "percents" parameter:
 ///
-/// ```json
+/// ```JSON
 /// {
 ///     "percentiles": {
 ///         "field": "load_time",
@@ -90,7 +90,7 @@ fn default_as_true() -> bool {
 }
 
 impl PercentilesAggregationReq {
-    /// Creates a new [`PercentilesAggregation`] instance from a field name.
+    /// Creates a new [`PercentilesAggregationReq`] instance from a field name.
     pub fn from_field_name(field_name: String) -> Self {
         PercentilesAggregationReq {
             field: field_name,

src/aggregation/mod.rs

@@ -25,8 +25,7 @@
 //! Aggregations request and result structures de/serialize into elasticsearch compatible JSON.
 //!
 //! Notice: Intermediate aggregation results should not be de/serialized via JSON format.
-//! See compatibility tests here: https://github.com/PSeitz/test_serde_formats
-//! TLDR: use ciborium.
+//! Postcard is a good choice.
 //!
 //! ```verbatim
 //! let agg_req: Aggregations = serde_json::from_str(json_request_string).unwrap();
@@ -39,6 +38,7 @@
 //! ## Supported Aggregations
 //! - [Bucket](bucket)
 //!     - [Histogram](bucket::HistogramAggregation)
+//!     - [DateHistogram](bucket::DateHistogramAggregationReq)
 //!     - [Range](bucket::RangeAggregation)
 //!     - [Terms](bucket::TermsAggregation)
 //! - [Metric](metric)
@@ -48,6 +48,7 @@
 //!     - [Max](metric::MaxAggregation)
 //!     - [Sum](metric::SumAggregation)
 //!     - [Count](metric::CountAggregation)
+//!     - [Percentiles](metric::PercentilesAggregationReq)
 //!
 //! # Example
 //! Compute the average metric, by building [`agg_req::Aggregations`], which is built from an
@@ -121,7 +122,7 @@
 //! [`merge_fruits`](intermediate_agg_result::IntermediateAggregationResults::merge_fruits) method
 //! to merge multiple results. The merged result can then be converted into
 //! [`AggregationResults`](agg_result::AggregationResults) via the
-//! [`into_final_bucket_result`](intermediate_agg_result::IntermediateAggregationResults::into_final_bucket_result) method.
+//! [`into_final_result`](intermediate_agg_result::IntermediateAggregationResults::into_final_result) method.
 
 mod agg_limits;
 pub mod agg_req;