Skip to content

Commit

Permalink
Minor: Fix typos in the documentation (#4376)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
martin-g authored Nov 26, 2022
1 parent 12b5a1b commit 7310385
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/source/user-guide/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ Available commands inside DataFusion CLI are:
- Search and describe function
```bash
> \h function_table
> \h function
```
- Show configuration options
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/dataframe.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/sql/explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/sql/information_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
+---------------+--------------+------------+-------------+-----------+-------------+
```

Expand Down

0 comments on commit 7310385

Please sign in to comment.