📝 Clarify testing documentation about checking stderr
#335
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.
Hello.
First thank for all your hard work on this project.
Today I wanted to test a small utility function and check that a message was printed into the standard error.
From the documentation, the only mention was
But using it directly, in fact, does not work.
After looking the code, it seems that Click's
CliRunner
mix standard output and error onstdout
by default. You need to ask explicitly to do not mix them in order to be able to read theresult.stderr
property.Then, I find the current documentation confusing because does not mention that and can lead reader to think it should work out of the box. In fact, I firsts started by double-checking my code before understand that the runner did not have the expected behavior.
So I suggest a small addition to the current note, at least to provide insight for readers.
Please let me know if I can improve it.