diff --git a/crates/polars/src/docs/lazy.rs b/crates/polars/src/docs/lazy.rs index 161aafc29eeb..cf0c6f9f35e6 100644 --- a/crates/polars/src/docs/lazy.rs +++ b/crates/polars/src/docs/lazy.rs @@ -103,7 +103,7 @@ //! //! ## Groupby //! -//! This example is from the polars [user guide](https://docs.pola.rs/user-guide/concepts/contexts/#group_by-aggregation). +//! This example is from the polars [user guide](https://docs.pola.rs/user-guide/concepts/expressions-and-contexts/#group_by-and-aggregations). //! //! ``` //! use polars::prelude::*; diff --git a/crates/polars/src/lib.rs b/crates/polars/src/lib.rs index b04ce28bb056..3da4b4469251 100644 --- a/crates/polars/src/lib.rs +++ b/crates/polars/src/lib.rs @@ -145,7 +145,7 @@ //! (Note that within an expression there may be more parallelization going on). //! //! Understanding Polars expressions is most important when starting with the Polars library. Read more -//! about them in the [user guide](https://docs.pola.rs/user-guide/concepts/expressions). +//! about them in the [user guide](https://docs.pola.rs/user-guide/expressions). //! //! ### Eager //! Read more in the pages of the following data structures /traits. diff --git a/docs/source/user-guide/plugins/index.md b/docs/source/user-guide/plugins/index.md new file mode 100644 index 000000000000..faaaeebc2472 --- /dev/null +++ b/docs/source/user-guide/plugins/index.md @@ -0,0 +1,5 @@ +# Plugins + +In this chapter you will learn how to write plugins in order to extend the Polars API. + +- [Your first Polars plugin](your-first-polars-plugin.md) diff --git a/mkdocs.yml b/mkdocs.yml index 5d4ca83b9191..5b2a900da32b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,7 @@ nav: - user-guide/io/bigquery.md - user-guide/io/hugging-face.md - Plugins: + - user-guide/plugins/index.md - user-guide/plugins/your-first-polars-plugin.md - SQL: - user-guide/sql/intro.md diff --git a/py-polars/docs/source/reference/plugins.rst b/py-polars/docs/source/reference/plugins.rst index e49d69f0a119..7a121ee11dce 100644 --- a/py-polars/docs/source/reference/plugins.rst +++ b/py-polars/docs/source/reference/plugins.rst @@ -4,7 +4,7 @@ Plugins .. currentmodule:: polars Plugins allow for extending Polars' functionality. See the -`user guide `_ for more information +`user guide `_ for more information and resources. Available plugin utility functions are: diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py index 361fbeb6b9fc..65b483a6dafe 100644 --- a/py-polars/polars/expr/expr.py +++ b/py-polars/polars/expr/expr.py @@ -10561,7 +10561,7 @@ def register_plugin( .. deprecated:: 0.20.16 Use :func:`polars.plugins.register_plugin_function` instead. - See the `user guide `_ + See the `user guide `_ for more information about plugins. Warnings diff --git a/py-polars/polars/plugins.py b/py-polars/polars/plugins.py index a501f8b5ed09..762a3e56a029 100644 --- a/py-polars/polars/plugins.py +++ b/py-polars/polars/plugins.py @@ -36,7 +36,7 @@ def register_plugin_function( """ Register a plugin function. - See the `user guide `_ + See the `user guide `_ for more information about plugins. Parameters