This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 49aee89796 : (#11110)
49aee89796 is described below
commit 49aee89796f7a61ba9e4705cc6023a577ea93659
Author: Andrew Lamb <[email protected]>
AuthorDate: Tue Jun 25 13:11:37 2024 -0400
: (#11110)
---
datafusion-examples/README.md | 5 +++--
docs/source/index.rst | 4 ++--
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/datafusion-examples/README.md b/datafusion-examples/README.md
index f78be6a398..217738a467 100644
--- a/datafusion-examples/README.md
+++ b/datafusion-examples/README.md
@@ -19,7 +19,8 @@
# DataFusion Examples
-This crate includes several examples of how to use various DataFusion APIs and
help you on your way.
+This crate includes end to end, highly commented examples of how to use
+various DataFusion APIs to help you get started.
## Prerequisites:
@@ -27,7 +28,7 @@ Run `git submodule update --init` to init test files.
## Running Examples
-To run the examples, use the `cargo run` command, such as:
+To run an example, use the `cargo run` command, such as:
```bash
git clone https://github.com/apache/datafusion
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 8500c70623..8677b63c91 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -41,9 +41,9 @@ DataFusion offers SQL and Dataframe APIs, excellent
CSV, Parquet, JSON, and Avro, extensive customization, and a great
community.
-The `example usage`_ section in the user guide and the `datafusion-examples`_
code in the crate contain information on using DataFusion.
+To get started with examples, see the `example usage`_ section of the user
guide and the `datafusion-examples`_ directory.
-Please see the `developer’s guide`_ for contributing and `communication`_ for
getting in touch with us.
+See the `developer’s guide`_ for contributing and `communication`_ for getting
in touch with us.
.. _example usage: user-guide/example-usage.html
.. _datafusion-examples:
https://github.com/apache/datafusion/tree/main/datafusion-examples
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
