Skip to content

Commit b6799cf

Browse files
committed
Some more changes to the docstrings
1 parent c9a7924 commit b6799cf

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

‎python/pyarrow/parquet/core.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1189,6 +1189,9 @@ class ParquetDataset:
11891189
Encapsulates details of reading a complete Parquet dataset possibly
11901190
consisting of multiple files and partitions in subdirectories.
11911191
1192+
Keywords `metadata`, `split_row_groups=True` and `validate_schema=False`
1193+
are not yet supported.
1194+
11921195
Parameters
11931196
----------
11941197
path_or_paths : str or List[str]
@@ -1242,9 +1245,6 @@ class ParquetDataset:
12421245
use_legacy_dataset : bool, optional
12431246
Deprecated and has no effect from PyArrow version 15.0.0.
12441247
1245-
Keywords `metadata`, `split_row_groups=True` and `validate_schema=False`
1246-
are not yet supported.
1247-
12481248
Examples
12491249
--------
12501250
{2}
@@ -1617,8 +1617,6 @@ def partitioning(self):
16171617
no columns.
16181618
use_threads : bool, default True
16191619
Perform multi-threaded column reads.
1620-
metadata : FileMetaData
1621-
If separately computed
16221620
schema : Schema, optional
16231621
Optionally provide the Schema for the parquet dataset, in which case it
16241622
will not be inferred from the source.
@@ -1667,6 +1665,9 @@ def partitioning(self):
16671665
sufficient for most Parquet files.
16681666
page_checksum_verification : bool, default False
16691667
If True, verify the checksum for each page read from the file.
1668+
metadata : FileMetaData
1669+
This keyword is no longer supported and is being deprecated with
1670+
PyArrow version 15.0.0.
16701671
16711672
Returns
16721673
-------
@@ -1773,7 +1774,8 @@ def read_table(source, *, columns=None, use_threads=True,
17731774
if metadata is not None:
17741775
raise ValueError(
17751776
"The 'metadata' keyword is no longer supported with the new "
1776-
"datasets-based implementation."
1777+
"datasets-based implementation and will be removed in future "
1778+
"versions."
17771779
)
17781780
try:
17791781
dataset = ParquetDataset(

0 commit comments

Comments
 (0)