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

GH-37217: [Python] Add missing docstrings to Cython #37218

Merged
merged 19 commits into from
Aug 18, 2023
Merged

GH-37217: [Python] Add missing docstrings to Cython #37218

merged 19 commits into from
Aug 18, 2023

Conversation

danepitkin
Copy link
Member

@danepitkin danepitkin commented Aug 16, 2023 •
edited by github-actions bot
Loading

Rationale for this change

The Cython 3.0.0 upgrade #37097 is triggering numpydoc errors for these missing docstrings.

What changes are included in this PR?

  • Docstrings added to Cython functions that omitted them

Are these changes tested?

Yes, locally.

Are there any user-facing changes?

User-facing documentation is added.

@danepitkin danepitkin requested a review from wjones127 as a code owner August 16, 2023 21:34
@github-actions
Copy link

⚠️ GitHub issue #37217 has been automatically assigned in GitHub to PR creator.

@danepitkin danepitkin requested review from kou and AlenkaF August 16, 2023 21:35
@danepitkin
Copy link
Member Author

I took a quick pass at adding docstrings. There are a lot so I didn't make them all perfect, e.g. some descriptions weren't added for functions that are self-explanatory. Let me know what level of detail is acceptable to merge! I'm happy to improve them as requested.

@danepitkin danepitkin mentioned this pull request Aug 16, 2023
Merged
kou
kou reviewed Aug 17, 2023
View reviewed changes
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not familiar format for docstring but I think that this minimal contents are enough as the first step.

python/pyarrow/_parquet.pyx Outdated Show resolved Hide resolved
python/pyarrow/array.pxi Outdated Show resolved Hide resolved
python/pyarrow/gandiva.pyx Outdated Show resolved Hide resolved
python/pyarrow/gandiva.pyx Outdated Show resolved Hide resolved
python/pyarrow/gandiva.pyx Outdated Show resolved Hide resolved
python/pyarrow/tensor.pxi Outdated Show resolved Hide resolved
python/pyarrow/tensor.pxi Show resolved Hide resolved
python/pyarrow/types.pxi Outdated Show resolved Hide resolved
python/pyarrow/types.pxi Outdated Show resolved Hide resolved
python/pyarrow/types.pxi Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Aug 17, 2023
AlenkaF
AlenkaF reviewed Aug 17, 2023
View reviewed changes
python/pyarrow/table.pxi Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Aug 17, 2023
danepitkin and others added 9 commits August 17, 2023 09:59
@danepitkin @kou
Update python/pyarrow/gandiva.pyx
90fb99d 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/types.pxi
0637b1c 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/types.pxi
187d73b 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/gandiva.pyx
d5527bd 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/io.pxi
64a0d7f 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/io.pxi
6b6f8d0 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/types.pxi
d41b20d 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/tensor.pxi
d07253a 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin @kou
Update python/pyarrow/tensor.pxi
11fa110 
Co-authored-by: Sutou Kouhei <[email protected]>
@danepitkin
Copy link
Member Author

Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.

@danepitkin
Copy link
Member Author

All comments have been resolved. Thanks for the feedback!

kou
kou approved these changes Aug 18, 2023
View reviewed changes
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou kou merged commit ca1a0eb into apache:main Aug 18, 2023
@kou kou removed the awaiting change review Awaiting change review label Aug 18, 2023
@github-actions github-actions bot added the awaiting merge Awaiting merge label Aug 18, 2023
@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit ca1a0eb.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them.

loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
@danepitkin @AlenkaF
@kou @loicalleyne
apacheGH-37217: [Python] Add missing docstrings to Cython (apache#37218)
8f12838 
### Rationale for this change

The Cython 3.0.0 upgrade apache#37097 is triggering numpydoc errors for these missing docstrings.

### What changes are included in this PR?

* Docstrings added to Cython functions that omitted them

### Are these changes tested?

Yes, locally.

### Are there any user-facing changes?

User-facing documentation is added.
* Closes: apache#37217

Lead-authored-by: Dane Pitkin <[email protected]>
Co-authored-by: Dane Pitkin <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlenkaF AlenkaF AlenkaF left review comments

@kou kou kou approved these changes

@wjones127 wjones127 Awaiting requested review from wjones127 wjones127 is a code owner

@jorisvandenbossche jorisvandenbossche Awaiting requested review from jorisvandenbossche

Assignees
No one assigned
Labels
awaiting merge Awaiting merge Component: Gandiva Component: Python
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Python] Add missing docstrings to Cython functions
3 participants
@danepitkin @kou @AlenkaF