Skip to content

Commit 734a813

Browse files
timsaucerclaude
andcommitted
docs: drop module-level doc comment from physical_optimizer
Sibling FFI-import modules (udf, udaf, catalog, table) carry no module-level docs, and the rst-style markup did not match Rust conventions. The function doc comment already states intent. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3909faf commit 734a813

1 file changed

Lines changed: 0 additions & 17 deletions

File tree

crates/core/src/physical_optimizer.rs

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,6 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! Imports physical optimizer rules supplied by another library over FFI.
19-
//!
20-
//! DataFusion has no FFI bridge for the logical [`OptimizerRule`] /
21-
//! [`AnalyzerRule`] traits, but it does export
22-
//! [`FFI_PhysicalOptimizerRule`] for the physical
23-
//! [`PhysicalOptimizerRule`] trait. A producer crate (typically a separate
24-
//! compiled extension) exposes an object with a
25-
//! ``__datafusion_physical_optimizer_rule__`` method returning a
26-
//! :class:`PyCapsule` that wraps an [`FFI_PhysicalOptimizerRule`]. This
27-
//! module reads that capsule and converts it into an
28-
//! ``Arc<dyn PhysicalOptimizerRule>`` so it can be registered with a
29-
//! [`SessionContext`](datafusion::prelude::SessionContext) at construction
30-
//! time.
31-
//!
32-
//! [`OptimizerRule`]: datafusion::optimizer::optimizer::OptimizerRule
33-
//! [`AnalyzerRule`]: datafusion::optimizer::analyzer::AnalyzerRule
34-
3518
use std::ptr::NonNull;
3619
use std::sync::Arc;
3720

0 commit comments

Comments
 (0)