Skip to content

docs: document variadic parameters with leading star - #3032

Open
antonwolfy wants to merge 1 commit into
masterfrom
docs/variadic-args-star
Open

docs: document variadic parameters with leading star#3032
antonwolfy wants to merge 1 commit into
masterfrom
docs/variadic-args-star

Conversation

@antonwolfy

@antonwolfy antonwolfy commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

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

Checklist

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

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 antonwolfy added this to the 0.21.0 release milestone Aug 19, 2026
@antonwolfy antonwolfy self-assigned this Aug 19, 2026
@antonwolfy
antonwolfy marked this pull request as ready for review August 19, 2026 13:18
@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions

Copy link
Copy Markdown
Contributor

Array API standard conformance tests for dpnp=0.21.0dev5=py314ha0e2e8e_4 ran successfully.
Passed: 1376
Failed: 1
Skipped: 5

@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 78.461% (+0.003%) from 78.458% — docs/variadic-args-star into master

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.

2 participants