GH-34017: [Python][FlightRPC][Doc] Fix read_chunk docstring for FlightStreamReader and MetadataRecordBatchReader
#38641
Conversation
This file contains 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
|
|
github-actions
bot
added
awaiting merge
|
After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit 80503a6. There were no benchmark performance regressions. 🎉 The full Conbench report has more details. |
loicalleyne
pushed a commit
to loicalleyne/arrow
that referenced
this pull request
Nov 13, 2023
…or FlightStreamReader and MetadataRecordBatchReader (apache#38641) ### Rationale for this change The docs for `FlightStreamReader` and `MetadataRecordBatchReader` currently list an incorrect return type for the `read_chunk` method - see apache#34017. NB: this issue was partially addressed by apache#35583. ### What changes are included in this PR? Simple docstring update for `read_chunk`. ### Are these changes tested? No (v minor docstring only change) ### Are there any user-facing changes? Yes * Closes: apache#34017 Authored-by: Nick Hughes <[email protected]> Signed-off-by: David Li <[email protected]>
dgreiss
pushed a commit
to dgreiss/arrow
that referenced
this pull request
Feb 19, 2024
…or FlightStreamReader and MetadataRecordBatchReader (apache#38641) ### Rationale for this change The docs for `FlightStreamReader` and `MetadataRecordBatchReader` currently list an incorrect return type for the `read_chunk` method - see apache#34017. NB: this issue was partially addressed by apache#35583. ### What changes are included in this PR? Simple docstring update for `read_chunk`. ### Are these changes tested? No (v minor docstring only change) ### Are there any user-facing changes? Yes * Closes: apache#34017 Authored-by: Nick Hughes <[email protected]> Signed-off-by: David Li <[email protected]>
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
The docs for
FlightStreamReaderandMetadataRecordBatchReadercurrently list an incorrect return type for theread_chunkmethod - see #34017. NB: this issue was partially addressed by #35583.What changes are included in this PR?
Simple docstring update for
read_chunk.Are these changes tested?
No (v minor docstring only change)
Are there any user-facing changes?
Yes