dankogai / p5-encode

Encode - character encodings (for Perl 5.8 or better)
https://metacpan.org/release/Encode
37 stars 51 forks source link

Use note() instead of diag() #164

Closed jkeenan closed 2 years ago

jkeenan commented 2 years ago

In the documentation for Test::More, the note() function is described as "Handy for putting in notes which might be useful for debugging, but don't indicate a problem." diag() is mainly intended to be used in situations where a unit test has failed and more diagnostic output would be helpful in debugging.

Here, we're simply making a note of the name of the tempfile created during testing, so note() is more appropriate.

In addition, note() prints to STDOUT when the tests are run as part of a harness; diag() prints to STDERR. When Encode's test suite is run as part of the Perl 5 core distribution's test suite, this diag() statement is the only statement that gets printed to STDERR. Once this p.r. is applied, a new version of Encode is released to CPAN, and that version is synched into blead, then Perl's test suite will run entirely to STDOUT.

dankogai commented 2 years ago

Thank you!