Use asserts instead of println in Display docstrings #403
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
To better convey the results and make sure the user expectations are set right, use `assert_eq` + `format` instead of `println` that is not very informative without specifying what should be printed.
Contributor
Author
|
I was hasty and missed an incorrect copy-paste. Now everything should pass |
Owner
|
Seems reasonable to me 👍 |
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.
I've recently discovered that I was using strum incorrectly assuming that content of variants will be printed. In 0.26 the content can be printed but as this is not the default, I've decided that it may still be beneficial to clarify in the docs what to expect from the default option.
To better convey the results and make sure the user expectations are set right, I propose to use
assert_eq+formatinstead ofprintlnas the latter is not very informative without specifying what should be printed as a result.