[arrow-datafusion] branch master updated: Fixup some doc warnings (#1811)

[al...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git


The following commit(s) were added to refs/heads/master by this push:
     new 7be0e26  Fixup some doc warnings (#1811)
7be0e26 is described below

commit 7be0e268a69ffecbf06823c98ca572733dddb29e
Author: Andrew Lamb <an...@nerdnetworks.org>
AuthorDate: Sat Feb 12 07:04:18 2022 -0500

    Fixup some doc warnings (#1811)
---
 datafusion-common/src/dfschema.rs                                  | 4 ++--
 datafusion/src/logical_plan/expr_simplier.rs                       | 4 +++-
 datafusion/src/optimizer/simplify_expressions.rs                   | 3 ++-
 datafusion/src/physical_plan/expressions/approx_percentile_cont.rs | 1 +
 datafusion/src/physical_plan/sorts/sort_preserving_merge.rs        | 2 +-
 5 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/datafusion-common/src/dfschema.rs b/datafusion-common/src/dfschema.rs
index 46321c3..df2cef6 100644
--- a/datafusion-common/src/dfschema.rs
+++ b/datafusion-common/src/dfschema.rs
@@ -402,8 +402,8 @@ impl Display for DFSchema {
     }
 }
 
-/// Provides schema information needed by [Expr] methods such as
-/// [Expr::nullable] and [Expr::data_type].
+/// Provides schema information needed by certain methods of `Expr`
+/// (defined in the datafusion-common crate).
 ///
 /// Note that this trait is implemented for &[DFSchema] which is
 /// widely used in the DataFusion codebase.
diff --git a/datafusion/src/logical_plan/expr_simplier.rs b/datafusion/src/logical_plan/expr_simplier.rs
index 06e5856..f5dc727 100644
--- a/datafusion/src/logical_plan/expr_simplier.rs
+++ b/datafusion/src/logical_plan/expr_simplier.rs
@@ -23,8 +23,10 @@ use crate::execution::context::ExecutionProps;
 use crate::optimizer::simplify_expressions::{ConstEvaluator, Simplifier};
 use datafusion_common::Result;
 
+#[allow(rustdoc::private_intra_doc_links)]
 /// The information necessary to apply algebraic simplification to an
-/// [Expr]. See [SimplifyContext] for one implementation
+/// [Expr]. See [SimplifyContext](crate::optimizer::simplify_expressions::SimplifyContext)
+/// for one implementation
 pub trait SimplifyInfo {
     /// returns true if this Expr has boolean type
     fn is_boolean_type(&self, expr: &Expr) -> Result<bool>;
diff --git a/datafusion/src/optimizer/simplify_expressions.rs b/datafusion/src/optimizer/simplify_expressions.rs
index c049a47..e1eacb6 100644
--- a/datafusion/src/optimizer/simplify_expressions.rs
+++ b/datafusion/src/optimizer/simplify_expressions.rs
@@ -35,7 +35,7 @@ use arrow::datatypes::{DataType, Field, Schema};
 use arrow::record_batch::RecordBatch;
 
 /// Provides simplification information based on schema and properties
-struct SimplifyContext<'a, 'b> {
+pub(crate) struct SimplifyContext<'a, 'b> {
     schemas: Vec<&'a DFSchemaRef>,
     props: &'b ExecutionProps,
 }
@@ -245,6 +245,7 @@ impl SimplifyExpressions {
     }
 }
 
+#[allow(rustdoc::private_intra_doc_links)]
 /// Partially evaluate `Expr`s so constant subtrees are evaluated at plan time.
 ///
 /// Note it does not handle algebraic rewrites such as `(a or false)`
diff --git a/datafusion/src/physical_plan/expressions/approx_percentile_cont.rs b/datafusion/src/physical_plan/expressions/approx_percentile_cont.rs
index cba30ee..0e41975 100644
--- a/datafusion/src/physical_plan/expressions/approx_percentile_cont.rs
+++ b/datafusion/src/physical_plan/expressions/approx_percentile_cont.rs
@@ -118,6 +118,7 @@ impl AggregateExpr for ApproxPercentileCont {
         Ok(Field::new(&self.name, self.input_data_type.clone(), false))
     }
 
+    #[allow(rustdoc::private_intra_doc_links)]
     /// See [`TDigest::to_scalar_state()`] for a description of the serialised
     /// state.
     fn state_fields(&self) -> Result<Vec<Field>> {
diff --git a/datafusion/src/physical_plan/sorts/sort_preserving_merge.rs b/datafusion/src/physical_plan/sorts/sort_preserving_merge.rs
index a948ceb..780e2cc 100644
--- a/datafusion/src/physical_plan/sorts/sort_preserving_merge.rs
+++ b/datafusion/src/physical_plan/sorts/sort_preserving_merge.rs
@@ -257,7 +257,7 @@ pub(crate) struct SortPreservingMergeStream {
     /// The sorted input streams to merge together
     streams: MergingStreams,
 
-    /// Drop helper for tasks feeding the [`receivers`](Self::receivers)
+    /// Drop helper for tasks feeding the input [`streams`](Self::streams)
     _drop_helper: AbortOnDropMany<()>,
 
     /// For each input stream maintain a dequeue of RecordBatches