Skip to content

Commit

Permalink
Docs/small improvements to the rust doc landing page (#4436)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonSchneider committed Aug 16, 2022
1 parent 81693c6 commit f1cd3c4
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion polars/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
//! * [Performance](#performance-and-string-data)
//! - [Custom allocator](#custom-allocator)
//! * [Config](#config-with-env-vars)
//! * [WASM target](#compile-for-wasm)
//! * [User Guide](#user-guide)
//!
//! ## Cookbooks
//! See examples in the cookbooks:
Expand Down Expand Up @@ -90,6 +90,9 @@
//! more verbose and less capable of building elegant composite queries. We recommend to use the Lazy API
//! whenever you can.
//!
//! As neither API is async they should be wrapped in `spawn_blocking` when used in an async context
//! to avoid blocking the async thread pool of the runtime.
//!
//! ## Expressions
//! Polars has a powerful concept called expressions.
//! Polars expressions can be used in various contexts and are a functional mapping of
Expand Down Expand Up @@ -286,6 +289,16 @@
//! #[global_allocator]
//! static GLOBAL: MiMalloc = MiMalloc;
//! ```
//! ```ignore
//! use jemallocator::Jemalloc;
//!
//! #[global_allocator]
//! static GLOBAL: Jemalloc = Jemalloc;
//! ```
//!
//! #### Notes
//! [Benchmarks](https://github.com/pola-rs/polars/pull/3108) have shown that on Linux JeMalloc
//! outperforms Mimalloc on all tasks and is therefor the default Linux allocator used for the Python bindings.
//!
//! #### Cargo.toml
//! ```ignore
Expand Down

0 comments on commit f1cd3c4

Please sign in to comment.