Skip to content

Commit 6de97ca

Browse files
committed
DOC: Improve kwargs docs for parquet engines
1 parent 1bd75cc commit 6de97ca

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

pandas/io/parquet.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -464,8 +464,12 @@ def to_parquet(
464464
465465
.. versionadded:: 2.1.0
466466
467-
kwargs
468-
Additional keyword arguments passed to the engine.
467+
**kwargs
468+
Additional keyword arguments passed to the engine:
469+
470+
* For ``engine="pyarrow"``: passed to :func:`pyarrow.parquet.write_table`
471+
or :func:`pyarrow.parquet.write_to_dataset` (when using partition_cols)
472+
* For ``engine="fastparquet"``: passed to :func:`fastparquet.write`
469473
470474
Returns
471475
-------
@@ -585,7 +589,11 @@ def read_parquet(
585589
.. versionadded:: 3.0.0
586590
587591
**kwargs
588-
Any additional kwargs are passed to the engine.
592+
Additional keyword arguments passed to the engine:
593+
594+
* For ``engine="pyarrow"``: passed to :func:`pyarrow.parquet.read_table`
595+
* For ``engine="fastparquet"``: passed to
596+
:meth:`fastparquet.ParquetFile.to_pandas`
589597
590598
Returns
591599
-------

0 commit comments

Comments
 (0)