Repository navigation
GH-46927: [Docs] [Python] document file path as option for source param - #55322
Open
willhopkins wants to merge 1 commit into
Open
willhopkins wants to merge 1 commit into
willhopkins wants to merge 1 commit into
Conversation
As described in issue 46927, the source param can take a file path. This commit documents that in the docstring.
willhopkins
changed the title
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
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
As described in issue 46927, the source param can take a file path. This commit documents that in the docstring.
One other person has claimed the issue, and one other person created (and abandoned back in 2025) a PR on the issue, so I feel this is safe to take on without stepping on any toes.
Fixes #46927
What changes are included in this PR?
+4: add ", file path" on each method or class's
sourceparam in the docstringAre these changes tested?
I ran the
pre-commitfor this repo, and my branch passed without changes. There are no non-documentation changes.Are there any user-facing changes?
There are visible documentation changes, but no changes to any of the APIs.
Was AI used for this PR?
In accordance to the AI generation guidelines, please disclose below whether and how AI was used in this PR.
PR code and description written by:
Reviewed before submission by:
sourceparameter to IPC readers can be a file path #46927