Skip to content

Update docstrings for elementwise functions #2406

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 35 commits into from
Apr 11, 2025
Merged

Update docstrings for elementwise functions #2406

merged 35 commits into from
Apr 11, 2025

Conversation

antonwolfy
Copy link
Contributor

@antonwolfy antonwolfy commented Apr 2, 2025 •
edited
Loading

The PR updates docstrings for elementwise functions to have a blank line prior Default value, also to add expected dtype of input arrays where missing, to align the dtypes with implementation and to fix some typos which were identified.
Also a description of include_initial keyword is aligned for cumulative functions.

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

@github-actions GitHub Actions
Copy link
Contributor

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

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

@github-actions GitHub Actions
Copy link
Contributor

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

Array API standard conformance tests for dpnp=0.18.0dev0=py312he4f9c94_112 ran successfully.
Passed: 1219
Failed: 0
Skipped: 10

@antonwolfy antonwolfy force-pushed the update-trigonometric-docstrings branch from 9881031 to 963e22a Compare April 2, 2025 16:21
@coveralls
Copy link
Collaborator

coveralls commented Apr 2, 2025 •
edited
Loading

Coverage Status

coverage: 72.271%. remained the same
when pulling 8c2afc9 on update-trigonometric-docstrings
into 4c66b58 on master.

@antonwolfy antonwolfy force-pushed the update-trigonometric-docstrings branch 8 times, most recently from 31a3db7 to dd8a897 Compare April 7, 2025 09:49
antonwolfy added 18 commits April 9, 2025 15:17
@antonwolfy
Add blank lines prior Default value and description of include_initial
88a9605
@antonwolfy
Update docstring of acos function to use math where applicable.
bdf5599 
Also `arccos` is now alias on `acos` function.
Limitation block is aligned along all trigonometric functions.
@antonwolfy
Replace nan with NaN
790e50c
@antonwolfy
Use :math:\pi where applicable
2157258
@antonwolfy
Use :math:\infty where applicable
1f0f9dd
@antonwolfy
Update docstring of acosh function to use math where applicable.
6396684 
Also `arccosh` is now alias on `acosh` function.
@antonwolfy
Update See also in acos and acosh functions
beb9c1e
@antonwolfy
Update docstring of asin and asinh function to use math where app…
9abce32 
…licable.

Also `arcsin` is now alias on `asin` function.
And `arcsinh` is now alias on `asinh` function.
@antonwolfy
Update branch cuts intervals in acos, acosh, asin, and asinh
4f39caa
@antonwolfy
Update docstring of atan, atan2, and atanh functions to use mat…
bc879bf 
…h where applicable.

Also `arctan` is now alias on `atan` function.
And `arctan2` is now alias on `atan2` function.
And `arctanh` is now alias on `atanh` function.
@antonwolfy
Remove unnecessary reruning of tests in testing MKL interfaces GH action
926c203
@antonwolfy
Update docstring of cbrt function
378d252
@antonwolfy
Update docstring of cos and cosh function to use math where appli…
335d0f8 
…cable.
@antonwolfy
Replace real floating-point with real-valued floating-point per
ef8be1d 
array API spec
@antonwolfy
Replace real-valued with real-valued floating-point per array API…
870570a 
… spec
@antonwolfy
Update docstring of cumlogsumexp function
be87542
@antonwolfy
Update docstring of deg2rad, rad2deg, radians, and degrees fu…
3e02fbf 
…nctions to use math where applicable
@antonwolfy
Update docstring of exp, exp2, and expm1 functions to use math …
80b90c3 
…where applicable
antonwolfy added 12 commits April 9, 2025 15:17
@antonwolfy
Update docstring of hypot function to use math where applicable
bac9deb
@antonwolfy
Update docstring of log, log10, log1p, and log2 functions to …
0e35d64 
…use math where applicable
@antonwolfy
Update docstring of logaddexp, logaddexp2 and cumlogsumexp func…
75dd574 
…tions to use math where applicable
@antonwolfy
Update docstring of reciprocal, rsqrt and sqrt functions to use…
fc27d3a 
… math where applicable
@antonwolfy
Update docstring of reduce_hypot function to use math where applicable
f7e2d20
@antonwolfy
Update docstring of sin and sinh functions to use math where appl…
8c3bccb 
…icable
@antonwolfy
Update square, tan, tanh and unwrap functions to use math whe…
89d93e6 
…re applicable
@antonwolfy
Rephrase see also link on dpnp.power
6a41c48
@antonwolfy
Update bitwise functions to add notes and to tune docstrings for inpu…
8be126f 
…t arrays
@antonwolfy
Update logic functions to add notes and to tune docstrings for input …
b5683ff 
…arrays
@antonwolfy
Update math functions to add notes and to tune docstrings for input a…
bb711a1 
…rrays
@antonwolfy
Rephrase a case when an input array may have any dtype
ae17868
@antonwolfy antonwolfy force-pushed the update-trigonometric-docstrings branch from 0c111d6 to ae17868 Compare April 9, 2025 13:18
@antonwolfy antonwolfy marked this pull request as ready for review April 9, 2025 13:18
@antonwolfy antonwolfy changed the title Update docstrings for trigonometric functions Update docstrings for elementwise functions Apr 9, 2025
vtavana
vtavana reviewed Apr 9, 2025
View reviewed changes
vtavana
vtavana approved these changes Apr 10, 2025
View reviewed changes
Copy link
Contributor

@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 bbe197a into master Apr 11, 2025
68 checks passed
@antonwolfy antonwolfy deleted the update-trigonometric-docstrings branch April 11, 2025 18:15
github-actions bot added a commit that referenced this pull request Apr 11, 2025
@github-actions
Update docstrings for elementwise functions (#2406)
4e69314 
The PR updates docstrings for elementwise functions to have a blank line
prior `Default` value, also to add expected dtype of input arrays where
missing, to align the dtypes with implementation and to fix some typos
which were identified.
Also a description of `include_initial` keyword is aligned for
cumulative functions. bbe197a
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexanderKalistratov AlexanderKalistratov Awaiting requested review from AlexanderKalistratov

@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

1 more reviewer

@vtavana vtavana vtavana approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@antonwolfy @coveralls @vtavana