You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "Fokko (via GitHub)" <gi...@apache.org> on 2023/02/03 20:44:44 UTC
[GitHub] [arrow] Fokko opened a new pull request, #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Fokko opened a new pull request, #34038:
URL: https://github.com/apache/arrow/pull/34038
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
```
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor PR](https://github.com/apache/arrow/blob/master/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
In the case of PARQUET issues on JIRA the title also supports:
PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
-->
### Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
### What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
### Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
### Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
-->
<!-- **This PR includes breaking changes to public APIs.** -->
<!--
Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious.
-->
<!-- **This PR contains a "Critical Fix".** -->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] mapleFU commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "mapleFU (via GitHub)" <gi...@apache.org>.
mapleFU commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1420130781
(So, can this patch be merged? Seems some of my patch is blocked by pydoc...)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] westonpace commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "westonpace (via GitHub)" <gi...@apache.org>.
westonpace commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1419247931
The `test-ubuntu-default-docs` job was missing substrait but that was fixed two days ago. Maybe rebase this?
As for the fix, was the intention to deprecate `pyarrow.Table.drop`? It isn't clear to me from the original ticket though it would make sense. CC @danepitkin @amol-
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1416384905
:warning: GitHub issue #34037 **has been automatically assigned in GitHub** to PR creator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] ursabot commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "ursabot (via GitHub)" <gi...@apache.org>.
ursabot commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1421420592
Benchmark runs are scheduled for baseline = d1e5cb55152ab468092e0c126b1ed987a09ba487 and contender = 1ab1f6f159ebf4df1216f28288207a357bbb4017. 1ab1f6f159ebf4df1216f28288207a357bbb4017 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/ebf961b9a8064b06813970b806d7ee73...224ce6f646b44cd581040efa3aa26589/)
[Failed :arrow_down:0.28% :arrow_up:0.0%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/3e342891fbbf483f957f922bcc610034...f2face15493c472e90b817ed69e3b027/)
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/6055a7ea3da644809035e8beff5fc83d...7a83ff4631d7464c9963f1751867d536/)
[Finished :arrow_down:0.22% :arrow_up:0.03%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/b855ca067b5a4fd4bf3396cb0f063311...04c2860da55a4b54b1b8ccaf8376c45a/)
Buildkite builds:
[Finished] [`1ab1f6f1` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2340)
[Finished] [`1ab1f6f1` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2368)
[Finished] [`1ab1f6f1` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2338)
[Finished] [`1ab1f6f1` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2359)
[Finished] [`d1e5cb55` ec2-t3-xlarge-us-east-2](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ec2-t3-xlarge-us-east-2/builds/2339)
[Failed] [`d1e5cb55` test-mac-arm](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-test-mac-arm/builds/2367)
[Finished] [`d1e5cb55` ursa-i9-9960x](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-i9-9960x/builds/2337)
[Finished] [`d1e5cb55` ursa-thinkcentre-m75q](https://buildkite.com/apache-arrow/arrow-bci-benchmark-on-ursa-thinkcentre-m75q/builds/2358)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] kou commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1418309116
@github-actions crossbow submit test-ubuntu-default-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] jorisvandenbossche merged pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "jorisvandenbossche (via GitHub)" <gi...@apache.org>.
jorisvandenbossche merged PR #34038:
URL: https://github.com/apache/arrow/pull/34038
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] Fokko commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1416532224
cc @jorisvandenbossche @westonpace this fixes the CI on master 👍🏻
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] wgtmac commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "wgtmac (via GitHub)" <gi...@apache.org>.
wgtmac commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1420259450
> (So, can this patch be merged? Seems some of my patch is blocked by pydoc...)
Same here: https://github.com/apache/arrow/actions/runs/4110851940/jobs/7094056424
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1418310510
Revision: 8251f42b49d15bcaa04257bc3286c23e3bfa731b
Submitted crossbow builds: [ursacomputing/crossbow @ actions-639508a0f9](https://github.com/ursacomputing/crossbow/branches/all?query=actions-639508a0f9)
|Task|Status|
|----|------|
|test-ubuntu-default-docs|[](https://github.com/ursacomputing/crossbow/runs/11123920945)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] westonpace commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "westonpace (via GitHub)" <gi...@apache.org>.
westonpace commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1419329816
@github-actions crossbow submit test-ubuntu-default-docs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] Fokko commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1420389088
> 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 🚀
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] Fokko commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "Fokko (via GitHub)" <gi...@apache.org>.
Fokko commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1419315187
@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 `.drop` on a table implies to me that it will drop the whole table. Therefore I figured it made sense to deprecate it for now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1419333850
Revision: bd63def1ab3f3307fdc5adc988be65f4e8a5a720
Submitted crossbow builds: [ursacomputing/crossbow @ actions-b7a4d96192](https://github.com/ursacomputing/crossbow/branches/all?query=actions-b7a4d96192)
|Task|Status|
|----|------|
|test-ubuntu-default-docs|[](https://github.com/ursacomputing/crossbow/runs/11141532096)|
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #34038: GH-34037: [Python][Docs] Fix Table.drop docstring
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #34038:
URL: https://github.com/apache/arrow/pull/34038#issuecomment-1416384881
* Closes: #34037
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org