Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-45322: [Docs][Python] Added hyperbolic trig functions to PyArrow API reference #45472

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

deekshatomer
Copy link

@deekshatomer deekshatomer commented Feb 10, 2025

Description

Added hyperbolic trigonometric functions (sinh, cosh, tanh, etc.) to the PyArrow API reference documentation.

Motivation

Currently, these functions were missing from the documentation. This PR improves clarity and completeness.

Changes

  • Updated docs/source/compute.rst to include hyperbolic trig functions.

Testing

  • Verified that the documentation builds correctly without errors.

Issue

Fixes GH-45322

Copy link

Thanks for opening a pull request!

If this is not a minor PR. 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 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}

See also:

Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution.
Could you use our guidelines for PR title?
https://arrow.apache.org/docs/developers/overview.html#pull-request-and-review
Could you also not delete the body of the PR description and follow the instructions there?

@deekshatomer deekshatomer changed the title fixes :# 45322 GH-45322: [Documentation] Added hyperbolic trig functions to PyArrow API reference Feb 10, 2025
@deekshatomer
Copy link
Author

Thanks for your contribution. Could you use our guidelines for PR title? https://arrow.apache.org/docs/developers/overview.html#pull-request-and-review Could you also not delete the body of the PR description and follow the instructions there?

@raulcd Thanks for the feedback! I have updated the PR title and description as per the guidelines. Please review.

Copy link
Member

@raulcd raulcd left a comment

Choose a reason for hiding this comment

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

Could you add them as a new Hyperbolic trigonometric functions section similar to how it was done for CPP:
https://github.com/apache/arrow/blob/main/docs/source/cpp/compute.rst?plain=1#L724-L750

cosh_checked
tanh
tanh_checked
asinh
Copy link
Member

Choose a reason for hiding this comment

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

can you order them in alphabetical order?

@kou kou changed the title GH-45322: [Documentation] Added hyperbolic trig functions to PyArrow API reference GH-45322: [Docs][Python] Added hyperbolic trig functions to PyArrow API reference Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs][Python] Add Hyperbolic Trig functions to API docs
2 participants