docs: document variadic parameters with leading star - #3032
Merged
Conversation
Several docstrings documented variadic parameters without the leading `*`/`**`, so the type read like a single value rather than a sequence. Align them with the numpydoc convention (as used by broadcast/broadcast_arrays): - apply_along_axis: `args`/`kwargs` -> `*args`/`**kwargs` - check_supported_arrays_type: `arrays` -> `*arrays` - _compute_res_dtype: `arrays` -> `*arrays`
antonwolfy
marked this pull request as ready for review
August 19, 2026 13:18
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
August 19, 2026 13:18
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
Contributor
|
Array API standard conformance tests for dpnp=0.21.0dev5=py314ha0e2e8e_6 ran successfully. |
Collaborator
|
coverage: 78.477%. remained the same — docs/variadic-args-star into master |
vlad-perevezentsev
approved these changes
Aug 20, 2026
vlad-perevezentsev
left a comment
vlad-perevezentsev
left a comment
Contributor
There was a problem hiding this comment.
LGTM
Thank you @antonwolfy
github-actions Bot
added a commit
that referenced
this pull request
Aug 20, 2026
Several docstrings documented variadic parameters without the leading `*`/`**`, so the rendered type read like a single value rather than a sequence of arguments. This aligns them with the numpydoc convention (and with `dpnp.broadcast` / `dpnp.broadcast_arrays` / `dpnp.broadcast_shapes`, which already use `*args`). Changes (documentation only, no behavior change): - `apply_along_axis`: `args` / `kwargs` -> `*args` / `**kwargs` - `check_supported_arrays_type`: `arrays` -> `*arrays` - `_compute_res_dtype`: `arrays` -> `*arrays` d02ed45
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Several docstrings documented variadic parameters without the leading
*/**, so the rendered type read like a single value rather than a sequence of arguments. This aligns them with the numpydoc convention (and withdpnp.broadcast/dpnp.broadcast_arrays/dpnp.broadcast_shapes, which already use*args).Changes (documentation only, no behavior change):
apply_along_axis:args/kwargs->*args/**kwargscheck_supported_arrays_type:arrays->*arrays_compute_res_dtype:arrays->*arraysChecklist