Update docstrings for dpnp.scipy.linalg LU functions#2802
Open
antonwolfy wants to merge 4 commits intomasterfrom
Open
Update docstrings for dpnp.scipy.linalg LU functions#2802antonwolfy wants to merge 4 commits intomasterfrom
dpnp.scipy.linalg LU functions#2802antonwolfy wants to merge 4 commits intomasterfrom
Conversation
Change parameter types from `{None, bool}` to `bool` for overwrite_a,
check_finite, and overwrite_b parameters to match SciPy's documentation.
These parameters are boolean flags that do not accept None as a valid
value according to the documented API.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change 'Warning' to 'Warnings' (plural) in docstring section headers across multiple modules to follow NumPy/SciPy documentation style guide. Files modified: - dpnp/scipy/linalg/_decomp_lu.py (3 functions) - dpnp/dpnp_iface_histograms.py (5 functions) - dpnp/dpnp_iface_manipulation.py (2 functions) - dpnp/dpnp_iface_nanfunctions.py (4 functions) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Change :obj: to :func: for function references in See Also sections to be more semantically correct according to Sphinx documentation conventions. Updated 5 function cross-references in scipy.linalg._decomp_lu module. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
View rendered docs @ https://intelpython.github.io/dpnp/pull/2802/index.html |
antonwolfy
force-pushed
the
update-docstring-for-lu
branch
from
1f11691 to
79079e3
Compare
Collaborator
Contributor
|
Array API standard conformance tests for dpnp=0.20.0dev3=py313h509198e_16 ran successfully. |
Replace bold asterisk formatting with clearer conditional returns documentation: - Add explanatory sentence about tuple returns based on permute_l - List all return values (p, l, pl, u) at the top level for Napoleon - Maintain clear structure: explanation first, then "where:" with details Also add missing period to parameter description in lu_solve. This ensures proper Sphinx/Napoleon rendering while keeping the clear explanation of which tuples are returned. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
antonwolfy
force-pushed
the
update-docstring-for-lu
branch
from
79079e3 to
5b4c119
Compare
antonwolfy
requested review from
ndgrigorian and
vlad-perevezentsev
as code owners
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
2 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 implements few improvements for LU function in
dpnp.scipy.linalgnamespace:Returnssection formatting inlufunctionfunc:role for the functions cross-references inSee alsosectionWarningssection name instead ofWarning{None, bool}toboolfor overwrite_a, check_finite, and overwrite_b parameters