alamb commented on code in PR #17691: URL: https://github.com/apache/datafusion/pull/17691#discussion_r2366231078
########## datafusion/pruning/README.md: ########## @@ -0,0 +1,32 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Apache DataFusion Pruning Logic + +[Apache DataFusion] is an extensible query execution framework, written in Rust, that uses [Apache Arrow] as its in-memory format. + +This crate is a submodule of DataFusion that contains pruning logic. Review Comment: Here is a suggestion from https://docs.rs/datafusion/latest/datafusion/physical_optimizer/pruning/struct.PruningPredicate.html ```suggestion This crate is a submodule of DataFusion that contains pruning logic, to analyzes filter expressions with statistics such as min/max values and null counts, to prove files / large subsections of files can be skipped without reading the actual data. ``` We could also add a link to the pruning predicate docs at https://docs.rs/datafusion/latest/datafusion/physical_optimizer/pruning/struct.PruningPredicate.html too ########## datafusion/ffi/README.md: ########## @@ -17,21 +17,21 @@ under the License. --> -# `datafusion-ffi`: Apache DataFusion Foreign Function Interface +# Apache DataFusion Foreign Function Interface -This crate contains code to allow interoperability of Apache [DataFusion] with -functions from other libraries and/or [DataFusion] versions using a stable +This crate contains code to allow interoperability of [Apache DataFusion] with +functions from other libraries and/or DataFusion versions using a stable interface. One of the limitations of the Rust programming language is that there is no stable [Rust ABI] (Application Binary Interface). If a library is compiled with one version of the Rust compiler and you attempt to use that library with a program compiled by a different Rust compiler, there is no guarantee that you can access the data structures. In order to share code between libraries loaded -at runtime, you need to use Rust's [FFI](Foreign Function Interface (FFI)). +at runtime, you need to use Rust's [FFI] (Foreign Function Interface (FFI)). Review Comment: this space fixes the link? ########## datafusion/catalog-listing/README.md: ########## @@ -17,9 +17,9 @@ under the License. --> -# DataFusion catalog-listing +# Apache DataFusion Catalog Listing Review Comment: ```suggestion # Apache DataFusion Catalog Listing(Table) ``` ########## datafusion/core/README.md: ########## @@ -17,15 +17,7 @@ under the License. --> -# DataFusion Core Review Comment: I had to double check that this file is not the main landing page https://crates.io/crates/datafusion It might help to have a comment about thiat ```suggestion <!-- Note the main crates.io landing page https://crates.io/crates/datafusion uses the workspace README.md file, not this file --> # DataFusion Core -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
