Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improve docstring clarity #20416

Merged
merged 1 commit into from
Dec 23, 2024
Merged

docs: Improve docstring clarity #20416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions py-polars/polars/dataframe/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
"""
Expand Down Expand Up @@ -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: ...

Expand All @@ -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: ...

Expand All @@ -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:
"""
Expand Down Expand Up @@ -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:
"""
Expand Down Expand Up @@ -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
Expand Down
Loading