From 5294cb5bc232915ac969c61e5863111b0b34148d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rodrigo=20Gir=C3=A3o=20Serr=C3=A3o?=
<5621605+rodrigogiraoserrao@users.noreply.github.com>
Date: Mon, 23 Dec 2024 14:20:08 +0000
Subject: [PATCH] docs: Improve docstring clarity (#20416)
---
py-polars/polars/dataframe/frame.py | 32 ++++++++++++++---------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/py-polars/polars/dataframe/frame.py b/py-polars/polars/dataframe/frame.py
index 4de12cc95aa6..9545733410fc 100644
--- a/py-polars/polars/dataframe/frame.py
+++ b/py-polars/polars/dataframe/frame.py
@@ -2827,9 +2827,9 @@ def write_csv(
null_value: str | None = None,
quote_style: CsvQuoteStyle | None = None,
storage_options: dict[str, Any] | None = None,
- credential_provider: CredentialProviderFunction
- | Literal["auto"]
- | None = "auto",
+ credential_provider: (
+ CredentialProviderFunction | Literal["auto"] | None
+ ) = "auto",
retries: int = 2,
) -> str | None:
"""
@@ -3614,9 +3614,9 @@ def write_ipc(
compression: IpcCompression = "uncompressed",
compat_level: CompatLevel | None = None,
storage_options: dict[str, Any] | None = None,
- credential_provider: CredentialProviderFunction
- | Literal["auto"]
- | None = "auto",
+ credential_provider: (
+ CredentialProviderFunction | Literal["auto"] | None
+ ) = "auto",
retries: int = 2,
) -> BytesIO: ...
@@ -3628,9 +3628,9 @@ def write_ipc(
compression: IpcCompression = "uncompressed",
compat_level: CompatLevel | None = None,
storage_options: dict[str, Any] | None = None,
- credential_provider: CredentialProviderFunction
- | Literal["auto"]
- | None = "auto",
+ credential_provider: (
+ CredentialProviderFunction | Literal["auto"] | None
+ ) = "auto",
retries: int = 2,
) -> None: ...
@@ -3642,9 +3642,9 @@ def write_ipc(
compression: IpcCompression = "uncompressed",
compat_level: CompatLevel | None = None,
storage_options: dict[str, Any] | None = None,
- credential_provider: CredentialProviderFunction
- | Literal["auto"]
- | None = "auto",
+ credential_provider: (
+ CredentialProviderFunction | Literal["auto"] | None
+ ) = "auto",
retries: int = 2,
) -> BytesIO | None:
"""
@@ -3828,9 +3828,9 @@ def write_parquet(
partition_by: str | Sequence[str] | None = None,
partition_chunk_size_bytes: int = 4_294_967_296,
storage_options: dict[str, Any] | None = None,
- credential_provider: CredentialProviderFunction
- | Literal["auto"]
- | None = "auto",
+ credential_provider: (
+ CredentialProviderFunction | Literal["auto"] | None
+ ) = "auto",
retries: int = 2,
) -> None:
"""
@@ -8455,7 +8455,7 @@ def pivot(
{'min', 'max', 'first', 'last', 'sum', 'mean', 'median', 'len'}
- An expression to do the aggregation.
maintain_order
- Sort the grouped keys so that the output order is predictable.
+ Ensure the values of `index` are sorted by discovery order.
sort_columns
Sort the transposed columns by name. Default is by order of discovery.
separator