Skip to content

Update dpnp.ndarray docstrings #2422

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 24 commits into from
Jul 24, 2025
Merged

Update dpnp.ndarray docstrings #2422

merged 24 commits into from
Jul 24, 2025

Conversation

antonwolfy
Copy link
Contributor

@antonwolfy antonwolfy commented Apr 15, 2025 •
edited
Loading

This PR improves documentations of dpnp.ndarray class, including:

  • adding missing docstrings to the methods and attributes
  • extending ndarray.rst page to have all methods and attributes rendered
  • aligning signatures of the methods with numpy.ndarray class
  • adding a page with dpnp constants
  • updating a link with dpnp.DLDeviceType enum

Also dpnp_array.py was added to pylint scope.

  • 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?

@antonwolfy antonwolfy self-assigned this Apr 15, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 15, 2025 •
edited
Loading

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

@coveralls
Copy link
Collaborator

coveralls commented Apr 15, 2025 •
edited
Loading

Coverage Status

coverage: 72.099% (+0.002%) from 72.097%
when pulling 844d4ed on update-ndarray-docstrings
into 9fc84dc on master.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 15, 2025 •
edited
Loading

Array API standard conformance tests for dpnp=0.19.0dev1=py313h509198e_41 ran successfully.
Passed: 1227
Failed: 0
Skipped: 9

@antonwolfy antonwolfy force-pushed the update-ndarray-docstrings branch 2 times, most recently from 830cb0e to d2c3879 Compare May 8, 2025 17:40
@antonwolfy antonwolfy added this to the 0.19.0 release milestone Jun 4, 2025
@antonwolfy antonwolfy force-pushed the update-ndarray-docstrings branch 3 times, most recently from 3fb56e4 to 0d295f8 Compare July 21, 2025 17:13
@antonwolfy antonwolfy force-pushed the update-ndarray-docstrings branch from 3db29e4 to 53b1a36 Compare July 21, 2025 19:36
@antonwolfy antonwolfy force-pushed the update-ndarray-docstrings branch from fee8e79 to 2b560f8 Compare July 23, 2025 14:19
@antonwolfy antonwolfy force-pushed the update-ndarray-docstrings branch from 2b560f8 to 6be05db Compare July 23, 2025 15:27
@antonwolfy antonwolfy marked this pull request as ready for review July 23, 2025 15:28
vtavana
vtavana reviewed Jul 23, 2025
View reviewed changes
antonwolfy and others added 6 commits July 23, 2025 20:29
@antonwolfy @vtavana
Apply suggestions from code review
a571c9a 
Co-authored-by: Vahid Tavanashad <120411540+vtavana@users.noreply.github.com>
@antonwolfy @vtavana
Update CHANGELOG.md
694b969 
Co-authored-by: Vahid Tavanashad <120411540+vtavana@users.noreply.github.com>
@antonwolfy
Aligned examples per review comment
e8127d4
@antonwolfy
Clarify common description of out keyword
aae481a
@antonwolfy @vtavana
Update dpnp/dpnp_array.py
649f01f 
Co-authored-by: Vahid Tavanashad <120411540+vtavana@users.noreply.github.com>
@antonwolfy
Return NotImplemented when non-default mod is passed to __pow__ and _…
77b8529 
…_rpow__
vtavana
vtavana approved these changes Jul 23, 2025
View reviewed changes
Copy link
Collaborator

@vtavana vtavana left a comment

Choose a reason for hiding this comment

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

Thank you, @antonwolfy!

@antonwolfy antonwolfy merged commit f93db81 into master Jul 24, 2025
185 of 190 checks passed
@antonwolfy antonwolfy deleted the update-ndarray-docstrings branch July 24, 2025 13:28
github-actions bot added a commit that referenced this pull request Jul 24, 2025
@github-actions
Update dpnp.ndarray docstrings (#2422)
915642e 
This PR improves documentations of `dpnp.ndarray` class, including:
- adding missing docstrings to the methods and attributes
- extending `ndarray.rst` page to have all methods and attributes
rendered
- aligning signatures of the methods with numpy.ndarray class
- adding a page with dpnp constants
- updating a link with `dpnp.DLDeviceType` enum

Also `dpnp_array.py` was added to pylint scope. f93db81
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vtavana vtavana vtavana approved these changes

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

@vlad-perevezentsev vlad-perevezentsev Awaiting requested review from vlad-perevezentsev vlad-perevezentsev is a code owner

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

Assignees

@antonwolfy antonwolfy

Labels
None yet
Projects
None yet
Milestone
0.19.0 release
Development

Successfully merging this pull request may close these issues.
3 participants
@antonwolfy @coveralls @vtavana