From ec4b9988342501aee158b6c12d27bdf5a230c262 Mon Sep 17 00:00:00 2001 From: Ryan Russell Date: Sat, 4 Jun 2022 14:57:38 -0500 Subject: [PATCH] Improve Docs Readability Signed-off-by: Ryan Russell --- CONTRIBUTING.md | 2 +- datafusion/CHANGELOG.md | 2 +- docs/source/community/communication.md | 2 +- docs/source/specification/invariants.md | 2 +- docs/source/specification/roadmap.md | 6 +++--- docs/source/user-guide/sql/sql_status.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 465a68ef8d49..7dfc7a23ff5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -82,7 +82,7 @@ You can run these tests individually using a command such as cargo test -p datafusion --tests sql_integration ``` -One very important test is the [sql_integraton](https://github.com/apache/arrow-datafusion/blob/master/datafusion/tests/sql_integration.rs) test which validates DataFusion's ability to run a large assortment of SQL queries against an assortment of data setsups. +One very important test is the [sql_integration](https://github.com/apache/arrow-datafusion/blob/master/datafusion/tests/sql_integration.rs) test which validates DataFusion's ability to run a large assortment of SQL queries against an assortment of data setups. ### SQL / Postgres Integration Tests diff --git a/datafusion/CHANGELOG.md b/datafusion/CHANGELOG.md index 1044a236ef4d..d60dbddb5985 100644 --- a/datafusion/CHANGELOG.md +++ b/datafusion/CHANGELOG.md @@ -351,7 +351,7 @@ - Create new `datafusion_expr` crate [\#1753](https://github.com/apache/arrow-datafusion/issues/1753) - Create new `datafusion_common` crate [\#1752](https://github.com/apache/arrow-datafusion/issues/1752) - API to get Expr's type and nullability without a `DFSchema` [\#1725](https://github.com/apache/arrow-datafusion/issues/1725) -- Cleaner API to create `Expr::ScalarFunction` programatically [\#1718](https://github.com/apache/arrow-datafusion/issues/1718) +- Cleaner API to create `Expr::ScalarFunction` programmatically [\#1718](https://github.com/apache/arrow-datafusion/issues/1718) - Introduce a `Vec` based row-wise representation for DataFusion [\#1708](https://github.com/apache/arrow-datafusion/issues/1708) - Simplify creating new `ListingTable` [\#1705](https://github.com/apache/arrow-datafusion/issues/1705) - Implement TableProvider for DataFrameImpl to allow registration of logical plans [\#1698](https://github.com/apache/arrow-datafusion/issues/1698) diff --git a/docs/source/community/communication.md b/docs/source/community/communication.md index d7fe3e03ee40..d55bfb62347e 100644 --- a/docs/source/community/communication.md +++ b/docs/source/community/communication.md @@ -31,7 +31,7 @@ conduct](https://www.apache.org/foundation/policies/conduct.html). ### Mailing list We use arrow.apache.org's `dev@` mailing list for project management, release -coorindation and design discussions +coordination and design discussions ([subscribe](mailto:dev-subscribe@arrow.apache.org), [unsubscribe](mailto:dev-unsubscribe@arrow.apache.org), [archives](https://lists.apache.org/list.html?dev@arrow.apache.org)). diff --git a/docs/source/specification/invariants.md b/docs/source/specification/invariants.md index 17b7c1dbbaba..430976306025 100644 --- a/docs/source/specification/invariants.md +++ b/docs/source/specification/invariants.md @@ -315,7 +315,7 @@ optimize(physical_plan).schema === physical_plan.schema ``` This is used to ensure that plans can be optimized without jeopardizing future -referencs of logical columns (name and index) or assumptions about their +references of logical columns (name and index) or assumptions about their schemas. #### Responsibility diff --git a/docs/source/specification/roadmap.md b/docs/source/specification/roadmap.md index 76b2896aa71c..e1d8ae9c0db2 100644 --- a/docs/source/specification/roadmap.md +++ b/docs/source/specification/roadmap.md @@ -30,7 +30,7 @@ Arrow](https://arrow.apache.org/) project and governed by the Apache Software Foundation governance model. These projects are entirely driven by volunteers, and we welcome contributions for items not on this roadmap. However, before submitting a large PR, we strongly -suggest you start a coversation using a github issue or the +suggest you start a conversation using a github issue or the dev@arrow.apache.org mailing list to make review efficient and avoid surprises. @@ -44,8 +44,8 @@ to provide: 1. Best-in-class single node query performance 2. A Declarative SQL query interface compatible with PostgreSQL 3. A Dataframe API, similar to those offered by Pandas and Spark -4. A Procedural API for programatically creating and running execution plans -5. High performance, data race free, erogonomic extensibility points at at every layer +4. A Procedural API for programmatically creating and running execution plans +5. High performance, data race free, ergonomic extensibility points at at every layer ## Additional SQL Language Features diff --git a/docs/source/user-guide/sql/sql_status.md b/docs/source/user-guide/sql/sql_status.md index 8b2a32938835..925ea27044a1 100644 --- a/docs/source/user-guide/sql/sql_status.md +++ b/docs/source/user-guide/sql/sql_status.md @@ -140,7 +140,7 @@ DataFusion is designed to be extensible at all points. To that end, you can prov - [x] User Defined `LogicalPlan` nodes - [x] User Defined `ExecutionPlan` nodes -## Rust Version Compatbility +## Rust Version Compatibility This crate is tested with the latest stable version of Rust. We do not currently test against other, older versions of the Rust compiler.