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

Merged
kou merged 19 commits into
apache:mainfrom
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged

GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom
danepitkin:danepitkin/numpydocs

Conversation

@danepitkin

@danepitkindanepitkin commented Aug 16, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

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.

@github-actions

github-actionsBot commented Aug 16, 2023

Copy link
Copy Markdown

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

@danepitkin
danepitkin requested review from AlenkaF and kouAugust 16, 2023 21:35
@danepitkin

danepitkin commented Aug 16, 2023

Copy link
Copy Markdown
MemberAuthor

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.

@danepitkindanepitkin mentioned this pull request Aug 16, 2023
Merged
kou
kou reviewed Aug 17, 2023
View reviewed changes

@koukou left a comment

Copy link
Copy Markdown
Member

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.

Comment threadpython/pyarrow/_parquet.pyx Outdated
Comment threadpython/pyarrow/array.pxi Outdated
Comment threadpython/pyarrow/gandiva.pyx Outdated
Comment threadpython/pyarrow/gandiva.pyx Outdated
Comment threadpython/pyarrow/gandiva.pyx Outdated
Comment threadpython/pyarrow/tensor.pxi Outdated
Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi Outdated
Comment threadpython/pyarrow/types.pxi Outdated
Comment threadpython/pyarrow/types.pxi Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Aug 17, 2023
AlenkaF
AlenkaF reviewed Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi Outdated
danepitkinand others added 3 commits August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Aug 17, 2023
danepitkinand others added 9 commits August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others added 3 commits August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin

danepitkin commented Aug 17, 2023

Copy link
Copy Markdown
MemberAuthor

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

danepitkin
danepitkin commented Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx Outdated
@danepitkin

danepitkin commented Aug 17, 2023

Copy link
Copy Markdown
MemberAuthor

All comments have been resolved. Thanks for the feedback!

kou
kou approved these changes Aug 18, 2023
View reviewed changes

@koukou left a comment

Copy link
Copy Markdown
Member

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:mainAug 18, 2023
@koukou removed the awaiting change review Awaiting change review label Aug 18, 2023
@github-actionsgithub-actionsBot added the awaiting merge Awaiting merge label Aug 18, 2023
@conbench-apache-arrow

conbench-apache-arrowBot commented Aug 18, 2023

Copy link
Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees

No one assigned

Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
GH-37217: [Python] Add missing docstrings to Cython - #37218
Merged
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Aug 18, 2023
Merged
GH-37217: [Python] Add missing docstrings to Cython#37218
kou merged 19 commits into
apache:mainfrom 
danepitkin:danepitkin/numpydocs
Conversation
@danepitkin
@danepitkindanepitkin
commented
Aug 16, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
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.
@github-actions
github-actionsBot
commented
Aug 16, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #37217has been automatically assigned in GitHub to PR creator.
@danepitkin
danepitkin
requested review from
AlenkaF and kouAugust 16, 2023 21:35
@danepitkin
danepitkin
commented
Aug 16, 2023

Copy link


Copy Markdown

MemberAuthor
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.
@danepitkindanepitkin
mentioned this pull request
Aug 16, 2023
 Merged

kou
kou
reviewed
Aug 17, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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.
Comment threadpython/pyarrow/_parquet.pyx
Outdated

Comment threadpython/pyarrow/array.pxi
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/gandiva.pyx
Outdated

Comment threadpython/pyarrow/tensor.pxi
Outdated

Comment threadpython/pyarrow/tensor.pxi
Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

Comment threadpython/pyarrow/types.pxi
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Aug 17, 2023
AlenkaF
AlenkaF
reviewed
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/table.pxi
Outdated

danepitkinand others
added 3 commits
August 17, 2023 09:57
@danepitkin@kou
Update python/pyarrow/array.pxi
764ed62
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
a710339
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
020c32a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Aug 17, 2023
danepitkinand others
added 9 commits
August 17, 2023 09:59
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
90fb99d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
0637b1c
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
187d73b
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/gandiva.pyx
d5527bd
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
64a0d7f
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/io.pxi
6b6f8d0
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/types.pxi
d41b20d
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
d07253a
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
11fa110
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
danepitkinand others
added 3 commits
August 17, 2023 10:43
@danepitkin@AlenkaF
Update python/pyarrow/table.pxi
396700c
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
@danepitkin@kou
Update python/pyarrow/tensor.pxi
0800ded
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Dane Pitkin
Add return values to docs
dc9b614
@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
Thank you for all of the helpful feedback! I missed a lot.. the perils of such a big change.
danepitkin
danepitkin
commented
Aug 17, 2023
View reviewed changes
Comment threadpython/pyarrow/_parquet.pyx
Outdated

@danepitkin
danepitkin
commented
Aug 17, 2023

Copy link


Copy Markdown

MemberAuthor
All comments have been resolved. Thanks for the feedback!
kou
kou
approved these changes
Aug 18, 2023
View reviewed changes
@koukou
left a comment


Copy link


Copy Markdown

Member
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:mainAug 18, 2023
@koukou
removed
the 
awaiting change review
Awaiting change review
label
Aug 18, 2023
@github-actionsgithub-actionsBot
added
the 
awaiting merge
Awaiting merge
label
Aug 18, 2023
@conbench-apache-arrow
conbench-apache-arrowBot
commented
Aug 18, 2023

Copy link


Copy Markdown

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 <dane@voltrondata.com>
Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AlenkaFAlenkaFAlenkaF left review comments
@koukoukou approved these changes
@wjones127wjones127Awaiting requested review from wjones127wjones127 is a code owner
@jorisvandenbosschejorisvandenbosscheAwaiting requested review from jorisvandenbossche

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: GandivaComponent: 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