Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Python] Address docstrings in Streams and File Access (Stream Classes) #31507

Closed
Tracked by #31715
asfimport opened this issue Apr 1, 2022 · 2 comments · Fixed by #33698
Closed
Tracked by #31715

[Python] Address docstrings in Streams and File Access (Stream Classes) #31507

asfimport opened this issue Apr 1, 2022 · 2 comments · Fixed by #33698
Assignees
@AlenkaF
Labels
Component: Python Type: task
Milestone
12.0.0

Comments

@asfimport
Copy link
Collaborator

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.
@asfimport
Copy link
Collaborator Author

Todd Farmer / @toddfarmer:
This issue was last updated over 90 days ago, which may be an indication it is no longer being actively worked. To better reflect the current state, the issue is being unassigned per project policy. Please feel free to re-take assignment of the issue if it is being actively worked, or if you plan to start that work soon.

@asfimport
Copy link
Collaborator Author

Apache Arrow JIRA Bot:
This issue was last updated over 90 days ago, which may be an indication it is no longer being actively worked. To better reflect the current state, the issue is being unassigned per project policy. Please feel free to re-take assignment of the issue if it is being actively worked, or if you plan to start that work soon.

@asfimport asfimport mentioned this issue Jan 11, 2023
Closed
3 tasks
@AlenkaF AlenkaF self-assigned this Jan 16, 2023
@github-actions github-actions bot mentioned this issue Jan 16, 2023
Merged
AlenkaF added a commit that referenced this issue Feb 20, 2023
@AlenkaF @jorisvandenbossche
GH-31507: [Python] Address docstrings in Streams and File Access (Str…
f2d632e 
…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>
@AlenkaF AlenkaF added this to the 12.0.0 milestone Feb 20, 2023
fatemehp pushed a commit to fatemehp/arrow that referenced this issue Feb 24, 2023
@AlenkaF @jorisvandenbossche @fatemehp
apacheGH-31507: [Python] Address docstrings in Streams and File Acces…
fc6b73f 
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlenkaF AlenkaF

Labels
Component: Python Type: task
Projects
None yet
Milestone
12.0.0
Development

Successfully merging a pull request may close this issue.

GH-31507: [Python] Address docstrings in Streams and File Access (Stream Classes) AlenkaF/arrow
2 participants
@AlenkaF @asfimport