-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Python] Address docstrings in Streams and File Access (Stream Classes) #31507
Comments
Todd Farmer / @toddfarmer: |
Apache Arrow JIRA Bot: |
…eam Classes) (#33698) ### Rationale for this change Ensure docstrings for [Streams and File Access](https://arrow.apache.org/docs/python/api/files.html) - Stream Classes - have an Examples section. ### What changes are included in this PR? Docstrings are added to listed Stream Classes: - OSFile - PythonFile - BufferReader - BufferOutputStream - FixedSizeBufferWriter - MemoryMappedFile - CompressedInputStream - CompressedOutputStream ### Are these changes tested? Yes, locally with `pytest --doctest-cython --disable-warnings pyarrow` and on the CI with `Python / AMD64 Conda Python 3.9 Sphinx & Numpydoc` build. ### Are there any user-facing changes? No. * Closes: #31507 Lead-authored-by: Alenka Frim <frim.alenka@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
…s (Stream Classes) (apache#33698) ### Rationale for this change Ensure docstrings for [Streams and File Access](https://arrow.apache.org/docs/python/api/files.html) - Stream Classes - have an Examples section. ### What changes are included in this PR? Docstrings are added to listed Stream Classes: - OSFile - PythonFile - BufferReader - BufferOutputStream - FixedSizeBufferWriter - MemoryMappedFile - CompressedInputStream - CompressedOutputStream ### Are these changes tested? Yes, locally with `pytest --doctest-cython --disable-warnings pyarrow` and on the CI with `Python / AMD64 Conda Python 3.9 Sphinx & Numpydoc` build. ### Are there any user-facing changes? No. * Closes: apache#31507 Lead-authored-by: Alenka Frim <frim.alenka@gmail.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
Ensure docstrings for Streams and File Access - Stream Classes - have an
Examples
section.Reporter: Alenka Frim / @AlenkaF
Note: This issue was originally created as ARROW-16096. Please see the migration documentation for further details.
The text was updated successfully, but these errors were encountered: