This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/master by this push:
new 7310385e8 Minor: Fix typos in the documentation (#4376)
7310385e8 is described below
commit 7310385e8583255f02cf1f3ac013fd61f520272b
Author: Martin Grigorov <[email protected]>
AuthorDate: Sat Nov 26 14:45:32 2022 +0200
Minor: Fix typos in the documentation (#4376)
* Rename 'function_table' to 'function' in the User Guide cli docs
1. function_table sounds weird
2. The cli help uses just 'function' -
https://github.com/apache/arrow-datafusion/blob/e1204a5bf72c119123404463befb716adbdcff25/datafusion-cli/src/command.rs#L140
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
* Improve wording
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
* Fix typos
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
Signed-off-by: Martin Tzvetanov Grigorov <[email protected]>
---
docs/source/user-guide/cli.md | 4 ++--
docs/source/user-guide/dataframe.md | 2 +-
docs/source/user-guide/sql/explain.md | 2 +-
docs/source/user-guide/sql/information_schema.md | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/source/user-guide/cli.md b/docs/source/user-guide/cli.md
index 52f194ae2..3a4c453a7 100644
--- a/docs/source/user-guide/cli.md
+++ b/docs/source/user-guide/cli.md
@@ -235,7 +235,7 @@ Available commands inside DataFusion CLI are:
- Search and describe function
```bash
-> \h function_table
+> \h function
```
- Show configuration options
@@ -270,7 +270,7 @@ All available configuration options can be seen using `SHOW
ALL` as described ab
You can change the configuration options using environment
variables. `datafusion-cli` looks in the corresponding environment
-variable with an upper case name and all `.` is converted to `_`.
+variable with an upper case name and all `.` converted to `_`.
For example, to set `datafusion.execution.batch_size` to `1024` you
would set the `DATAFUSION_EXECUTION_BATCH_SIZE` environment variable
diff --git a/docs/source/user-guide/dataframe.md
b/docs/source/user-guide/dataframe.md
index e860242fc..77768dd8b 100644
--- a/docs/source/user-guide/dataframe.md
+++ b/docs/source/user-guide/dataframe.md
@@ -49,7 +49,7 @@ df.show();
The DataFrame API is well documented in the [API reference on
docs.rs](https://docs.rs/datafusion/latest/datafusion/dataframe/struct.DataFrame.html).
-Refer to the [Expressions Refence](expressions) for available functions for
building logical expressions for use with the
+Refer to the [Expressions Reference](expressions) for available functions for
building logical expressions for use with the
DataFrame API.
## DataFrame Transformations
diff --git a/docs/source/user-guide/sql/explain.md
b/docs/source/user-guide/sql/explain.md
index 08cc8be75..ae0795f9a 100644
--- a/docs/source/user-guide/sql/explain.md
+++ b/docs/source/user-guide/sql/explain.md
@@ -51,7 +51,7 @@ EXPLAIN SELECT SUM(x) FROM table GROUP BY b;
## EXPLAIN ANALYZE
-Shows the execution plan and metrics of a statment.
+Shows the execution plan and metrics of a statement.
If you need more information output, try to use `EXPLAIN ANALYZE VERBOSE`.
```sql
diff --git a/docs/source/user-guide/sql/information_schema.md
b/docs/source/user-guide/sql/information_schema.md
index a3964e9c3..b3fcc843b 100644
--- a/docs/source/user-guide/sql/information_schema.md
+++ b/docs/source/user-guide/sql/information_schema.md
@@ -48,7 +48,7 @@ or
+---------------+--------------+------------+-------------+-----------+-------------+
| table_catalog | table_schema | table_name | column_name | data_type |
is_nullable |
+---------------+--------------+------------+-------------+-----------+-------------+
-| datafusion | public | t1 | Int64(1) | Int64 | NO
|
+| datafusion | public | t | Int64(1) | Int64 | NO
|
+---------------+--------------+------------+-------------+-----------+-------------+
```
