MINOR: [Docs][Python] update exclude_invalid_files docstring to correct default behavior#47785
Merged
kou merged 1 commit intoapache:mainfrom Oct 13, 2025
Merged
MINOR: [Docs][Python] update exclude_invalid_files docstring to correct default behavior#47785kou merged 1 commit intoapache:mainfrom
exclude_invalid_files docstring to correct default behavior#47785kou merged 1 commit intoapache:mainfrom
Conversation
|
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename the pull request title in the following format? or See also: |
sidneymau
changed the title
exclude_invalid_files docstring to correct default behavior
sidneymau
changed the title
exclude_invalid_files docstring to correct default behaviorexclude_invalid_files docstring to correct default behavior
Member
|
@github-actions crossbow submit preview-docs |
|
Revision: cf925ea Submitted crossbow builds: ursacomputing/crossbow @ actions-2615655928
|
github-actions
bot
added
awaiting merge
|
After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit be6dddf. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
zanmato1984
pushed a commit
to zanmato1984/arrow
that referenced
this pull request
Oct 15, 2025
…rect default behavior (apache#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 apache#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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rationale for this change
This PR simply updates the default quoted in the docstring to the correct value for
exclude_invalid_filesindataset(see #47770).What changes are included in this PR?
The
exclude_invalid_filesdefault is now listed asFalseinstead ofTrueAre 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:
arrow/python/pyarrow/tests/test_dataset.py
Line 1149 in 5750e29
Are there any user-facing changes?
Updated documentation