alamb commented on code in PR #5921:
URL: https://github.com/apache/arrow-datafusion/pull/5921#discussion_r1161106797
##########
datafusion/common/src/tree_node.rs:
##########
@@ -289,7 +289,7 @@ impl<T> Transformed<T> {
/// Helper trait for implementing [`TreeNode`] that have children stored as
Arc's
///
/// If some trait object, such as `dyn T`, implements this trait,
-/// its related Arc<dyn T> will automatically implement [`TreeNode`]
+/// its related `Arc<dyn T>` will automatically implement [`TreeNode`]
Review Comment:
drive by rustdoc cleanups
##########
datafusion/core/src/lib.rs:
##########
@@ -100,57 +123,109 @@
//! # }
//! ```
//!
-//! ## Parse, Plan, Optimize, Execute
+//! ## More Examples
+//!
+//! There are many additional annotated examples of using DataFusion in the
[datafusion-examples] directory.
+//!
+//! [datafusion-examples]:
https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples
+//!
+//! ## Customization and Extension
Review Comment:
I rearranged and expanded the customization points
##########
datafusion/core/src/lib.rs:
##########
@@ -173,39 +248,24 @@
//! * Scan from memory: [`MemoryExec`](physical_plan::memory::MemoryExec)
//! * Explain the plan: [`ExplainExec`](physical_plan::explain::ExplainExec)
//!
-//! ## Customize
-//!
-//! DataFusion allows users to
-//! * extend the planner to use user-defined logical and physical nodes
([`QueryPlanner`](execution::context::QueryPlanner))
-//! * declare and use user-defined scalar functions
([`ScalarUDF`](physical_plan::udf::ScalarUDF))
-//! * declare and use user-defined aggregate functions
([`AggregateUDF`](physical_plan::udaf::AggregateUDF))
-//!
-//! You can find examples of each of them in examples section.
-//!
-//! ## Examples
-//!
-//! Examples are located in [datafusion-examples
directory](https://github.com/apache/arrow-datafusion/tree/main/datafusion-examples)
Review Comment:
I moved the link to the other examples up with the other examples, and then
moved the details on running closer to the examples themselves in the
`datafusion-examples` directory
##########
docs/source/contributor-guide/architecture.md:
##########
@@ -19,13 +19,8 @@
# Architecture
-There is no formal document describing DataFusion's architecture yet, but the
following presentations offer a good overview of its different components and
how they interact together.
+DataFusion's code structure and organization is described in the
+[Crate Documentation], to keep it as close to the source as
+possible.
-- [Apr 2023]: The Apache Arrow DataFusion Architecture talks series by @alamb
Review Comment:
Moved to the main library docs
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
