Skip to content

Commit

Permalink
Minor formatting stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego committed Oct 28, 2023
1 parent 5299b16 commit c8a5088
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,27 +34,27 @@ Polars is a highly performant DataFrame library for manipulating structured data

## About this guide

The `Polars` user guide is intended to live alongside the API documentation. Its purpose is to explain (new) users how to use `Polars` and to provide meaningful examples. The guide is split into two parts:
The Polars user guide is intended to live alongside the API documentation. Its purpose is to explain (new) users how to use `Polars` and to provide meaningful examples. The guide is split into two parts:

- [Getting Started](getting-started/intro.md): A 10 minute helicopter view of the library and its primary function.
- [User Guide](user-guide/index.md): A detailed explanation of how the library is setup and how to use it most effectively.
- [Getting started](getting-started/intro.md): A 10 minute helicopter view of the library and its primary function.
- [User guide](user-guide/index.md): A detailed explanation of how the library is setup and how to use it most effectively.

If you are looking for details on a specific level / object, it is probably best to go the API documentation: [Python](https://pola-rs.github.io/polars/py-polars/html/reference/index.html) | [Rust](https://docs.rs/polars/latest/polars/).

## Performance :rocket: :rocket:

`Polars` is very fast, and in fact is one of the best performing solutions available.
Polars is very fast, and in fact is one of the best performing solutions available.
See the results in h2oai's [db-benchmark](https://duckdblabs.github.io/db-benchmark/), revived by the DuckDB project.

`Polars` [TPCH Benchmark results](https://www.pola.rs/benchmarks.html) are now available on the official website.
Polars [TPC-H Benchmark results](https://www.pola.rs/benchmarks.html) are now available on the official website.

## Example

{{code_block('home/example','example',['scan_csv','filter','group_by','collect'])}}

## Community

`Polars` has a very active community with frequent releases (approximately weekly). Below are some of the top contributors to the project:
Polars has a very active community with frequent releases (approximately weekly). Below are some of the top contributors to the project:

--8<-- "docs/people.md"

Expand All @@ -64,4 +64,4 @@ We appreciate all contributions, from reporting bugs to implementing new feature

## License

This project is licensed under the terms of the MIT license.
This project is licensed under the terms of the [MIT license](https://github.com/pola-rs/polars/blob/main/LICENSE).

0 comments on commit c8a5088

Please sign in to comment.