Skip to content

Commit 0573f78

Browse files
authored
Update datafusion-cli docs, split up (#10078)
* Update datafusion-cli docs, split up * remove PiPI instructions
1 parent 8730466 commit 0573f78

File tree

8 files changed

+777
-665
lines changed

8 files changed

+777
-665
lines changed

datafusion-cli/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@
2323

2424
[DataFusion](https://arrow.apache.org/datafusion/) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
2525

26-
The DataFusion CLI is a command line utility that runs SQL queries using the DataFusion engine.
26+
DataFusion CLI (`datafusion-cli`) is a small command line utility that runs SQL queries using the DataFusion engine.
2727

2828
# Frequently Asked Questions
2929

3030
## Where can I find more information?
3131

32-
Answer: See the [`datafusion-cli` documentation](https://arrow.apache.org/datafusion/user-guide/cli.html) for further information.
32+
See the [`datafusion-cli` documentation](https://arrow.apache.org/datafusion/user-guide/cli.html) for further information.
3333

3434
## How do I make my IDE work with `datafusion-cli`?
3535

36-
Answer: "open" the `datafusion/datafusion-cli` project as its own top level
36+
"open" the `datafusion/datafusion-cli` project as its own top level
3737
project in my IDE (rather than opening `datafusion`)
3838

39-
The reason `datafusion-cli` is not listed as part of the workspace in the main
39+
The reason `datafusion-cli` is not part of the main workspace in
4040
[`datafusion Cargo.toml`] file is that `datafusion-cli` is a binary and has a
4141
checked in `Cargo.lock` file to ensure reproducible builds.
4242

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for
6767

6868
user-guide/introduction
6969
user-guide/example-usage
70-
user-guide/cli
70+
user-guide/cli/index
7171
user-guide/dataframe
7272
user-guide/expressions
7373
user-guide/sql/index

0 commit comments

Comments
 (0)