Repository navigation
Shorten the comments of the tests - #101
Merged
Merged
Conversation
Sixteen comment blocks of three or more lines, mostly in the tests of the complex input, are now of at most two lines: 63 lines of comment became 26. What they said is not lost, it is in the commits that added them. Only comment lines changed. The two issue links are kept, and so is every number a trap test needs to be read with - which value a wrong order would produce, what the extreme of a complex dtype is, why a nan value is built with complex() rather than by multiplying with 1j.
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
1 participant
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.
Sixteen comment blocks of three or more lines - mostly in the tests of the complex input - are now of at most two lines, 63 lines of comment became 26.
Only comment lines changed (
git diffcontains no line that is not a comment), ruff and pre-commit are happy, the two issue links are kept.What the long versions argued is not lost: the commits that added those tests carry it. What a reader needs to read the test with stayed in the comment - which value a wrong order would produce, that the extreme of a complex dtype is
inf+infjand notinf+0j, why a nan value is built withcomplex()rather than by multiplying with1j.Two other branches are open in the meantime, both touch
test_generic.py: #100 adds a test there (whose own comment I will shorten in that PR), and this one shortens comments around it. Whichever of the two lands second needs a rebase over a few lines of comment.