docs: Improve docstring clarity (#20416)

pola-rs · Dec 23, 2024 · 5294cb5 · 5294cb5
1 parent d4145fd
commit 5294cb5
Showing 1 changed file with 16 additions and 16 deletions.
diff --git 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