Skip to content

Updated expected dtypes of input arrays in docstrings of elementwise functions #2041

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.

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

Merged
merged 2 commits into from
Apr 9, 2025

Conversation

antonwolfy
Copy link
Collaborator

@antonwolfy antonwolfy commented Apr 7, 2025

This PR updates docstrings of elementwise functions to add expected dtype of input arrays where missing, to align the dtypes with implementation and to fix some typos which were identified.

  • 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?
  • If this PR is a work in progress, are you opening the PR as a draft?

Copy link

github-actions bot commented Apr 7, 2025

Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞

Copy link

github-actions bot commented Apr 7, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_108 ran successfully.
Passed: 893
Failed: 3
Skipped: 154

@coveralls
Copy link
Collaborator

coveralls commented Apr 7, 2025

Coverage Status

coverage: 86.381% (+0.003%) from 86.378%
when pulling c138cea on update-ufuncs-docstrings
into e39b013 on master.

@ndgrigorian
Copy link
Collaborator

Other than the above comment I think this would be fine to go in, thanks for taking the time for this @antonwolfy

@antonwolfy antonwolfy requested a review from ndgrigorian April 9, 2025 09:44
Copy link

github-actions bot commented Apr 9, 2025

Array API standard conformance tests for dpctl=0.20.0dev0=py310h93fe807_117 ran successfully.
Passed: 912
Failed: 2
Skipped: 154

Copy link
Collaborator

@ndgrigorian ndgrigorian left a comment

Choose a reason for hiding this comment

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

LGTM!

@ndgrigorian ndgrigorian merged commit d1fb36e into master Apr 9, 2025
76 checks passed
@ndgrigorian ndgrigorian deleted the update-ufuncs-docstrings branch April 9, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants