Skip to content

Commit

Permalink
: (#11110)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Jun 25, 2024
1 parent 58e2904 commit 49aee89
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions datafusion-examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@

# 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:

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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 49aee89

Please sign in to comment.