Cleans up elementwise function docstrings #1559
Merged
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
- abs input does not need to be numeric, as booleans are accepted
- Add can take `bool` inputs, not just numeric.
…unctions - proj expects complex inputs and does not always return the same data type as the original input - conj expects numeric inputs and does not return booleans - real, imag take any data type
- Round now notes that ties are rounded to the nearest even integer and no longer claims to always return the same data type - Floor does not always return the same data type - Ceil does not always return the same data type
- comparison functions expect any data type - divide expects floating-point data types
- log1p, logaddexp, and expm1 docstrings are now more descriptive - input types corrected in all cases
- input types corrected - 'check' changed to 'test'
- Fixed spacing throughout docstrings
|
Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞 |
|
Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_33 ran successfully. |
| @@ -954,10 +964,12 @@ | |||
| # U20: ==== LOG (x) | |||
| _log_docstring = """ | |||
| log(x, out=None, order='K') | |||
| Computes the natural logarithm element-wise. | |||
|
|
|||
| Computes the natural logarithm for each element `x_i` of input array `x`. | |||
There was a problem hiding this comment.
If we used "Test if each element ..." above, we should be consistent and use "Compute the natural logarithm ...".
No need to change it in this PR, but we should make a note of this and apply changes eventually.
oleksandr-pavlyk
approved these changes
Feb 22, 2024
There was a problem hiding this comment.
Thanks for tackling these changes @ndgrigorian
This PR is good to go in.
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.
This pull request makes a number of changes to the docstrings of element-wise functions, with a focus on guaranteeing that the information in the docstrings is correct and removing typos.
Each function, when referencing expected data types of inputs, now refers to the types which will not be cast. For example,
dpt.dividearguments now state that they expect floating-point data, as otherwise, the data will be copied and cast.