Fix missing Default: and optional markers in docstrings#2966
Merged
Conversation
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
Collaborator
|
coverage: 78.069%. remained the same — missing-default-optional-in-docstring into master |
Contributor
|
Array API standard conformance tests for dpnp=0.21.0dev1=py313h509198e_27 ran successfully. |
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
Co-authored-by: vlad-perevezentsev <vladislav.perevezentsev@intel.com>
vlad-perevezentsev
approved these changes
Jun 24, 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
Jun 24, 2026
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. e35392c
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.
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.tensorsubtree is intentionally left out and will be addressed in a separate PR, since currently there is no documentation rendering for it.