Skip to content

Align documentation reference with NumPy/CuPy short names #2633

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

Jump to bottom
Merged
merged 31 commits into from
Nov 5, 2025
Merged

Align documentation reference with NumPy/CuPy short names #2633

merged 31 commits into from
Nov 5, 2025
+864 −824

Conversation

@vlad-perevezentsev
Copy link
Contributor

@vlad-perevezentsev vlad-perevezentsev commented Oct 21, 2025 •
edited by antonwolfy
Loading

This PR proposes to align all sections in doc/reference with NumPy and CuPy documentation style by using short function names

Additionally, it adds hints with links to the corresponding NumPy API reference pages and fixes math rendering in gcd() and lcm() docstrings

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • Have you checked performance impact of proposed changes?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?

@vlad-perevezentsev
Align docs linalg with NumPy/CuPy short names
c8f7da4
@vlad-perevezentsev
Move linalg.outer to Matrix and vector products
45d4296
@vlad-perevezentsev
Align docs fft with NumPy/CuPy short names
47d2111
@vlad-perevezentsev
Align docs array creation with NumPy/CuPy short names
08bf166
@vlad-perevezentsev
Align docs array manipulation with NumPy/CuPy short names
2769e2b
@vlad-perevezentsev
Align docs bit-wise with NumPy/CuPy short names
226b8bb
@vlad-perevezentsev
Align docs data type with NumPy/CuPy short names
cd4ca37
@vlad-perevezentsev
Align docs functional with NumPy/CuPy short names
87efe3c
@vlad-perevezentsev
Align docs indexing with NumPy/CuPy short names
2a164ea
@vlad-perevezentsev
Align docs logic with NumPy/CuPy short names
56228c4
@vlad-perevezentsev
Align docs math with NumPy/CuPy short names
1c4abf7
@vlad-perevezentsev
Align docs ndarray with NumPy short names and title
4badb0e
@vlad-perevezentsev
Align docs miscellaneous with NumPy/CuPy short names and chapters
3497879
@vlad-perevezentsev
Align docs polynomials with NumPy/CuPy short names
d2a7862
@vlad-perevezentsev
Align docs random with NumPy/CuPy short names
5f90b4a
@vlad-perevezentsev
Align docs set with NumPy/CuPy short names
9c0d2fe
@vlad-perevezentsev
Align docs sorting with NumPy/CuPy short names
78e1a83
@vlad-perevezentsev
Align docs statistics with NumPy/CuPy short names
9df7605
@vlad-perevezentsev
Align docs ufunc with NumPy/CuPy short names
1e1c617
@vlad-perevezentsev
Fix math rendering in gcd and lcm docs
9aa5251
@vlad-perevezentsev
Align docs window with NumPy/CuPy short names
a68ae95
@vlad-perevezentsev vlad-perevezentsev self-assigned this Oct 21, 2025
@vlad-perevezentsev vlad-perevezentsev added this to the 0.20.0 release milestone Oct 21, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2025 •
edited
Loading

View rendered docs @ https://intelpython.github.io/dpnp/index.html

@github-actions
Copy link
Contributor

github-actions bot commented Oct 21, 2025 •
edited
Loading

Array API standard conformance tests for dpnp=0.20.0dev0=py313h509198e_58 ran successfully.
Passed: 1227
Failed: 0
Skipped: 9

@coveralls
Copy link
Collaborator

coveralls commented Oct 21, 2025 •
edited
Loading

Coverage Status

coverage: 81.51%. remained the same
when pulling ac553ad on short_name_in_docs
into 5b39d66 on master.

antonwolfy
antonwolfy reviewed Oct 29, 2025
View reviewed changes
Copy link
Contributor

@antonwolfy antonwolfy left a comment

Choose a reason for hiding this comment

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

Please add PR to the Changelog

antonwolfy
antonwolfy approved these changes Nov 4, 2025
View reviewed changes
Copy link
Contributor

@antonwolfy antonwolfy left a comment

Choose a reason for hiding this comment

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

LGTM with a small nit below

@antonwolfy antonwolfy merged commit 0c4d440 into master Nov 5, 2025
95 of 97 checks passed
@antonwolfy antonwolfy deleted the short_name_in_docs branch November 5, 2025 14:27
github-actions bot added a commit that referenced this pull request Nov 5, 2025
@github-actions
Align documentation reference with NumPy/CuPy short names (#2633)
ee9cbf4 
This PR proposes to align all sections in `doc/reference` with `NumPy`
and `CuPy` documentation style by using short function names

Additionally, it adds `hints` with links to the corresponding NumPy API
reference pages and fixes math rendering in `gcd()` and `lcm()`
docstrings 0c4d440
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@antonwolfy antonwolfy antonwolfy approved these changes

@ndgrigorian ndgrigorian Awaiting requested review from ndgrigorian ndgrigorian is a code owner

Assignees

@vlad-perevezentsev vlad-perevezentsev

Labels

None yet

Projects

None yet

Milestone

0.20.0 release

Development

Successfully merging this pull request may close these issues.

3 participants

@vlad-perevezentsev @coveralls @antonwolfy