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 (Factory Functions) #31506

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

[Python] Address docstrings in Streams and File Access (Factory Functions) #31506

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

Comments

@asfimport
Copy link
Collaborator

Ensure docstrings for Streams and File Access - Factory Functions - have an Examples section:

Reporter: Alenka Frim / @AlenkaF

Note: This issue was originally created as ARROW-16095. 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 11, 2023
@AlenkaF AlenkaF mentioned this issue Jan 11, 2023
Merged
kou pushed a commit that referenced this issue Jan 17, 2023
@AlenkaF
GH-31506: [Python] Address docstrings in Streams and File Access (Fac…
ef98a97 
…tory Functions) (#33609)

# Which issue does this PR close?
Closes #31506

# Rationale for this change
Ensure docstrings for [Streams and File Access](https://arrow.apache.org/docs/python/api/files.html) - Factory Functions - have an Examples section:

# What changes are included in this PR?
Added docstring examples for:
- `pyarrow.input_stream`
- `pyarrow.output_stream`
- `pyarrow.memory_map`
- `pyarrow.create_memory_map` 

 Also pytest argument ` --disable-warnings` for `pytest-cython` is added, see lgpage/pytest-cython#3: 

```python
=============================== warnings summary ===============================
opt/conda/envs/arrow/lib/python3.9/site-packages/pytest_cython/plugin.py:57
  /opt/conda/envs/arrow/lib/python3.9/site-packages/pytest_cython/plugin.py:57: PytestRemovedIn8Warning: The (fspath: py.path.local) argument to DoctestModule is deprecated. Please use the (path: pathlib.Path) argument instead.
  See https://docs.pytest.org/en/latest/deprecations.html#fspath-argument-for-node-constructors-replaced-with-pathlib-path
    return DoctestModule.from_parent(parent, fspath=path)
```

# 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: #31506

Authored-by: Alenka Frim <frim.alenka@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
@kou kou added this to the 12.0.0 milestone Jan 17, 2023
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-31506: [Python] Address docstrings in Streams and File Access (Factory Functions) AlenkaF/arrow
3 participants
@kou @AlenkaF @asfimport