DOC fix docstring of assert_allclose (atol is not being set based on the provided arrays' dtypes) #23555
Conversation
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
ogrisel
pushed a commit
to ogrisel/scikit-learn
that referenced
this pull request
Jul 11, 2022
… provided arrays' dtypes (scikit-learn#23555)
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Aug 4, 2022
… provided arrays' dtypes (scikit-learn#23555)
glemaitre
pushed a commit
that referenced
this pull request
Aug 5, 2022
… provided arrays' dtypes (#23555)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference Issues/PRs
Docstring fix moved to a separate PR (see #22059 (comment) @thomasjpfan)
What does this implement/fix? Explain your changes.
Fixes the docstring of
sklearn.utils._testing.assert_allclose. There, forrtolas well asatolit was stated that "If None, it is set based on the provided arrays' dtypes.". However, looking into the code it becomes clear that onlyrtolis dtype-aware (if set toNone) but notatol. Therefore, in this PR the statement is removed from theatoldocstring.