Skip to content

Update docstrings in indexing functions #2307

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 4 commits into from
Feb 11, 2025
Merged

Update docstrings in indexing functions #2307

merged 4 commits into from
Feb 11, 2025

Conversation

antonwolfy
Copy link
Contributor

@antonwolfy antonwolfy commented Feb 11, 2025 •
edited
Loading

The PR proposes to implement documentation improvements, including:

  • correct example in dpnp.select
  • updates docstrings for indexing functions to have a blank line prior Default value
  • align description of dtype keyword across all functions

Note, updates in other files with adding blank line prior Default will be covered separately.

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to 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?
  • If this PR is a work in progress, are you filing the PR as a draft?

@antonwolfy antonwolfy self-assigned this Feb 11, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 11, 2025 •
edited
Loading

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

vtavana
vtavana approved these changes Feb 11, 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!

@github-actions GitHub Actions
Copy link
Contributor

Array API standard conformance tests for dpnp=0.17.0dev6=py312he4f9c94_11 ran successfully.
Passed: 977
Failed: 0
Skipped: 23

@antonwolfy antonwolfy merged commit a7dd8ba into master Feb 11, 2025
69 of 70 checks passed
@antonwolfy antonwolfy deleted the update-indexing-docstrings branch February 11, 2025 23:52
github-actions bot added a commit that referenced this pull request Feb 12, 2025
@github-actions
Update docstrings in indexing functions (#2307)
00279df 
The PR proposes to implement documentation improvements, including:
- correct example in `dpnp.select`
- updates docstrings for indexing functions to have a blank line prior
`Default` value
- align description of `dtype` keyword across all functions

Note, updates in other files with adding blank line prior `Default` will
be covered separately. a7dd8ba
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

Assignees

@antonwolfy antonwolfy

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

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