GH-34037: [Python][Docs] Fix Table.drop docstring#34038
GH-34037: [Python][Docs] Fix Table.drop docstring#34038jorisvandenbossche merged 2 commits intoapache:masterfrom
Conversation
|
|
Fokko
force-pushed
the
fd-fix-drop-docstring
branch
2 times, most recently
from
3952651 to
8251f42
Compare
|
cc @jorisvandenbossche @westonpace this PR fixes the CI on master 👍🏻 |
|
@github-actions crossbow submit test-ubuntu-default-docs |
|
Revision: 8251f42b49d15bcaa04257bc3286c23e3bfa731b Submitted crossbow builds: ursacomputing/crossbow @ actions-639508a0f9
|
|
The As for the fix, was the intention to deprecate |
It throws errors in the CI:
```
pyarrow.lib.Table.drop
-> pyarrow.lib.Table.drop(self, columns)
PR01: Parameters {'columns'} not documented
pyarrow.lib.Table.drop
-> pyarrow.lib.Table.drop(self, columns)
PR01: Parameters {'columns'} not documented
pyarrow.lib.Table.drop
-> pyarrow.lib.Table.drop(self, columns)
PR01: Parameters {'columns'} not documented
Total number of docstring violations: 3
```
Fokko
force-pushed
the
fd-fix-drop-docstring
branch
from
8251f42 to
bd63def
Compare
|
@westonpace Thanks, I've just rebased the PR. I got the impression that it was to be deprecated according to the original docstring. My personal opinion is that having duplicate methods will confuse users, and there should be a single way of dropping columns. Calling |
|
@github-actions crossbow submit test-ubuntu-default-docs |
|
Revision: bd63def Submitted crossbow builds: ursacomputing/crossbow @ actions-b7a4d96192
|
|
(So, can this patch be merged? Seems some of my patch is blocked by pydoc...) |
|
jorisvandenbossche
left a comment
jorisvandenbossche
left a comment
There was a problem hiding this comment.
@Fokko Thanks for the PR!
I am personally fine with also actually deprecating the method (instead of keeping it as an alias), but I removed that here from this PR to just focus on fixing the docstring validation so that this can be merged quickly (on the deprecation I had some minor comments).
No problem at all, feel free to change such a PR any time to get it in. Getting the CI green is the most important part 🚀 Thanks for merging! |
|
Benchmark runs are scheduled for baseline = d1e5cb5 and contender = 1ab1f6f. 1ab1f6f is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
7 participants
It throws errors in the CI, while I was working on other docstrings:
Rationale for this change
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?