This is an automated email from the ASF dual-hosted git repository.
rok pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 924394732d GH-46374: [Python][Doc] Improve docs to specify that source
argument on parquet.read_table can also be a list of strings (#47142)
924394732d is described below
commit 924394732dbf8dbc1f332b15204fef0258abc267
Author: Soroush Rasti <[email protected]>
AuthorDate: Sun Jul 20 14:34:02 2025 +0200
GH-46374: [Python][Doc] Improve docs to specify that source argument on
parquet.read_table can also be a list of strings (#47142)
See #46374
### What changes are included in this PR?
The docstring for `parquet.read_table` doesn't specify that the source can
be a list of strings:
This is regarding the change for _read_table_docstring which source can be
a list of string as well
### Are there any user-facing changes?
Only docs changed.
* GitHub Issue: #46374
Authored-by: Soroush Rasti <[email protected]>
Signed-off-by: Rok Mihevc <[email protected]>
---
python/pyarrow/parquet/core.py | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/python/pyarrow/parquet/core.py b/python/pyarrow/parquet/core.py
index ef92565ea3..aaf15c2028 100644
--- a/python/pyarrow/parquet/core.py
+++ b/python/pyarrow/parquet/core.py
@@ -1679,10 +1679,11 @@ _read_table_docstring = """
Parameters
----------
-source : str, pyarrow.NativeFile, or file-like object
- If a string passed, can be a single file name or directory name. For
- file-like objects, only read a single file. Use pyarrow.BufferReader to
- read a file contained in a bytes or buffer-like object.
+source : str, list of str, pyarrow.NativeFile, or file-like object
+ If a string is passed, can be a single file name or directory name. If a
+ list of strings is passed, should be file names. For file-like objects,
+ only read a single file. Use pyarrow.BufferReader to read a file contained
+ in a bytes or buffer-like object.
columns : list
If not None, only these columns will be read from the file. A column
name may be a prefix of a nested field, e.g. 'a' will select 'a.b',
