From 9ea0b9a2f1f20f107f8ced740630aedc61e2c711 Mon Sep 17 00:00:00 2001 From: ritchie Date: Wed, 20 Nov 2024 17:57:08 +0100 Subject: [PATCH] doc(python): Explicit note section for coalescing note --- py-polars/polars/dataframe/frame.py | 5 +++-- py-polars/polars/lazyframe/frame.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/py-polars/polars/dataframe/frame.py b/py-polars/polars/dataframe/frame.py index 83bf19cd7f19..c2dbc3c944ad 100644 --- a/py-polars/polars/dataframe/frame.py +++ b/py-polars/polars/dataframe/frame.py @@ -7061,8 +7061,9 @@ def join( - True: -> Always coalesce join columns. - False: -> Never coalesce join columns. - Note that joining on any other expressions than `col` - will turn off coalescing. + .. note:: + Joining on any other expressions than `col` + will turn off coalescing. See Also -------- diff --git a/py-polars/polars/lazyframe/frame.py b/py-polars/polars/lazyframe/frame.py index fc93418efe5e..b52e77ceadd4 100644 --- a/py-polars/polars/lazyframe/frame.py +++ b/py-polars/polars/lazyframe/frame.py @@ -4450,8 +4450,9 @@ def join( - True: -> Always coalesce join columns. - False: -> Never coalesce join columns. - Note that joining on any other expressions than `col` - will turn off coalescing. + .. note:: + Joining on any other expressions than `col` + will turn off coalescing. allow_parallel Allow the physical plan to optionally evaluate the computation of both DataFrames up to the join in parallel.