Skip to content

Commit be6dddf

Browse files
authored
MINOR: [Docs][Python] update exclude_invalid_files docstring to correct default behavior (#47785)
### Rationale for this change This PR simply updates the default quoted in the docstring to the correct value for `exclude_invalid_files` in `dataset` (see #47770). ### What changes are included in this PR? The `exclude_invalid_files` default is now listed as `False` instead of `True` ### Are these changes tested? No, these changes only affect docstrings and not testable code. There is a test that appears to assert this behavior, though, so this updates the docstring to be consistent with an existing test: https://github.com/apache/arrow/blob/5750e2932fc26c27be92fe9262f6b128a513abca/python/pyarrow/tests/test_dataset.py#L1149 ### Are there any user-facing changes? Updated documentation Authored-by: Sidney Mau <sidneymau@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent 81ef967 commit be6dddf

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

python/pyarrow/_dataset.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3241,7 +3241,7 @@ cdef class FileSystemFactoryOptions(_Weakrefable):
32413241
partitioning : Partitioning/PartitioningFactory, optional
32423242
Apply the Partitioning to every discovered Fragment. See Partitioning or
32433243
PartitioningFactory documentation.
3244-
exclude_invalid_files : bool, optional (default True)
3244+
exclude_invalid_files : bool, optional (default False)
32453245
If True, invalid files will be excluded (file format specific check).
32463246
This will incur IO for each files in a serial and single threaded
32473247
fashion. Disabling this feature will skip the IO, but unsupported

python/pyarrow/dataset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ def dataset(source, schema=None, format=None, filesystem=None,
644644
partition_base_dir prefix will be skipped for partitioning discovery.
645645
The ignored files will still be part of the Dataset, but will not
646646
have partition information.
647-
exclude_invalid_files : bool, optional (default True)
647+
exclude_invalid_files : bool, optional (default False)
648648
If True, invalid files will be excluded (file format specific check).
649649
This will incur IO for each files in a serial and single threaded
650650
fashion. Disabling this feature will skip the IO, but unsupported

0 commit comments

Comments
 (0)