Skip to content

DOC: make descriptions of hyperbolic functions consistent #29297

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.

Sign up for GitHub

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

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

DOC: make descriptions of hyperbolic functions consistent #29297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions numpy/_core/code_generators/ufunc_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ def add_newdoc(place, name, doc):

add_newdoc('numpy._core.umath', 'arcsinh',
"""
Inverse hyperbolic sine element-wise.
Inverse hyperbolic sine, element-wise.

Parameters
----------
Expand Down Expand Up @@ -534,7 +534,7 @@ def add_newdoc(place, name, doc):

add_newdoc('numpy._core.umath', 'arctanh',
"""
Inverse hyperbolic tangent element-wise.
Inverse hyperbolic tangent, element-wise.

Parameters
----------
Expand Down Expand Up @@ -4256,7 +4256,7 @@ def add_newdoc(place, name, doc):

add_newdoc('numpy._core.umath', 'tanh',
"""
Compute hyperbolic tangent element-wise.
Hyperbolic tangent, element-wise.
Copy link
Member

Choose a reason for hiding this comment

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

I guess this is what motivated the PR?

If we are already changing this, I think it should be Element-wise hyperbolic tangent. What do you think? Whatever we decide, there are many other appearances of this in the file. It would be nice to align them all to the same template.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, that's what motivated the PR. I am ok with "Element-wise hyperbolic tangent". There are lots of cases like this in ufunc_docstrings.py. Should we start doing in batches, let's say "Trigonometric functions" and "Hyperbolic functions" first?


Equivalent to ``np.sinh(x)/np.cosh(x)`` or ``-1j * np.tan(1j*x)``.

Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy