You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "IndexSeek (via GitHub)" <gi...@apache.org> on 2024/10/26 12:52:10 UTC

[PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

IndexSeek opened a new pull request, #44537:
URL: https://github.com/apache/arrow/pull/44537

   <!--
   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/main/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
   
   In another project, I've been referring to the PyArrow Compute documentation quite a lot, and I believe having more documentation here would be helpful. 
   
   I added an example for Index, also to highlight the behavior of `start` and the -1 return if the value isn't found. 
   
   <!--
    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?
   
   Adding an example that should appear on the [pyarrow.compute.index](https://arrow.apache.org/docs/python/generated/pyarrow.compute.index.html#) documentation page. 
   <!--
   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?
   
   I ran this code using the latest version of PyArrow and ensured the outputs were as expected. I did not test building the documentation and rendering, although I would like to start doing this and learn more about this process for future documentation purposes. 
   
   <!--
   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?
   
   A new example would be available on the website. 
   
   <!--
   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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2443514086

   After merging your PR, Conbench analyzed the 3 benchmarking runs that have been run so far on merge-commit 6c95dfa2771ad3462c3a4e7a9e74ab4409a79c92.
   
   There were no benchmark performance regressions. 🎉
   
   The [full Conbench report](https://github.com/apache/arrow/runs/32203912385) has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.


-- 
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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2439736053

   Revision: f0fe136ca7305928a3da63ef2adc2ac573971f44
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-9a6b9067ff](https://github.com/ursacomputing/crossbow/branches/all?query=actions-9a6b9067ff)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-9a6b9067ff-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/11534940146/job/32109503025)|


-- 
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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2442537766

   @github-actions crossbow submit preview-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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "IndexSeek (via GitHub)" <gi...@apache.org>.
IndexSeek commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2441424416

   I moved this example into the actual docstring of the function.
   
   I will need to do a bit more digging into how it would work to add these in _compute_docstrings and better understand how this works:
   
   https://github.com/apache/arrow/blob/a3c39ecb778188539c3ec4b6c6f2b540d8e4be40/python/pyarrow/compute.py#L150
   
   Thank you for generating the preview docs and letting me know! I hope this will resolve it. 


-- 
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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2439735457

   @github-actions crossbow submit preview-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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2440255904

   http://crossbow.voltrondata.com/pr_docs/44537/python/generated/pyarrow.compute.index.html#pyarrow.compute.index
   
   Hmm. The added example doesn't exist...


-- 
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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #44537:
URL: https://github.com/apache/arrow/pull/44537#issuecomment-2442542131

   Revision: 7c2abdd168d7199603fca8bc8aa1f068bb9dafab
   
   Submitted crossbow builds: [ursacomputing/crossbow @ actions-1a7ed88deb](https://github.com/ursacomputing/crossbow/branches/all?query=actions-1a7ed88deb)
   
   |Task|Status|
   |----|------|
   |preview-docs|[![GitHub Actions](https://github.com/ursacomputing/crossbow/actions/workflows/crossbow.yml/badge.svg?branch=actions-1a7ed88deb-github-preview-docs)](https://github.com/ursacomputing/crossbow/actions/runs/11561952657/job/32182084208)|


-- 
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


Re: [PR] MINOR: [Docs][Python] Document example for pc.index [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #44537:
URL: https://github.com/apache/arrow/pull/44537


-- 
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