Skip to content

Fix missing Default: and optional markers in docstrings#2966

Open
antonwolfy wants to merge 1 commit into
masterfrom
missing-default-optional-in-docstring
Open

Fix missing Default: and optional markers in docstrings#2966
antonwolfy wants to merge 1 commit into
masterfrom
missing-default-optional-in-docstring

Conversation

@antonwolfy

@antonwolfy antonwolfy commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

This PR cleans up the documentation, so that optional parameters consistently document their default values.
The changes are documentation-only — no functional/runtime behavior is affected.

The dpnp.tensor subtree is intentionally left out and will be addressed in a separate PR, since currently there is no documentation rendering for it.

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

@antonwolfy antonwolfy added this to the 0.21.0 release milestone Jun 23, 2026
@antonwolfy antonwolfy self-assigned this Jun 23, 2026
@coveralls

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 78.069%. remained the same — missing-default-optional-in-docstring into master

@github-actions

Copy link
Copy Markdown
Contributor

Array API standard conformance tests for dpnp=0.21.0dev1=py313h509198e_22 ran successfully.
Passed: 1356
Failed: 4
Skipped: 16

@github-actions

Copy link
Copy Markdown
Contributor

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

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