[GitHub] [arrow-datafusion] alamb commented on a change in pull request #1811: Fixup some doc warnings

[GitBox <gi...@apache.org>]

alamb commented on a change in pull request #1811:
URL: https://github.com/apache/arrow-datafusion/pull/1811#discussion_r804947819



##########
File path: 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)

Review comment:
       I am kind of cheating here, but I think it is reasonable. 

##########
File path: 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`

Review comment:
       now that `Expr` is in a crate that is not used by `datafusion-common` I don't see a good way to offer a docklink (until we have published the version to crates.io / docs.rs)

##########
File path: 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)

Review comment:
       yeah this code has been significantly changed since the original docstring was introduced




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org