DOC: make descriptions of hyperbolic functions consistent #29297
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattip
reviewed
Jul 1, 2025
| @@ -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. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
currently if you go to https://numpy.org/devdocs/reference/routines.math.html#hyperbolic-functions
there are a few inconsistencies in hyperbolic function descriptions shown in the figure below:
this PR fixes those minor issues.