Align documentation reference with NumPy/CuPy short names #2633
+853
−811
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
vlad-perevezentsev
requested review from
antonwolfy and
ndgrigorian
as code owners
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/2633/index.html |
|
Array API standard conformance tests for dpnp=0.20.0dev0=py313h509198e_35 ran successfully. |
antonwolfy
reviewed
Oct 29, 2025
| @@ -1,9 +1,11 @@ | |||
| .. _routines.array-creation: | |||
|
|
|||
| .. currentmodule:: dpnp | |||
There was a problem hiding this comment.
Do we need to update doc/reference/array_api.rst ?
| vander | ||
|
|
||
|
|
||
| The Matrix class |
There was a problem hiding this comment.
We can no plans to support the matrxi class. And I guess the CuPy also does not have that.
Can we remove that?
| ============================================ | ||
|
|
||
| .. https://numpy.org/doc/stable/reference/routines.fft.html | ||
| .. hint:: `NumPy API Reference: Discrete Fourier Transform (numpy.fft) <https://numpy.org/doc/stable/reference/routines.fft.html>`_ |
There was a problem hiding this comment.
It seems the hint is missing for doc/reference/exceptions.rst.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 PR proposes to align all sections in
doc/referencewithNumPyandCuPydocumentation style by using short function namesAdditionally, it adds
hintswith links to the corresponding NumPy API reference pages and fixes math rendering ingcd()andlcm()docstrings