Improve documentation of the Stopwatch extension #461
Labels
Projects
Milestone
Comments
14 tasks
Michael1993
pushed a commit
that referenced
this issue
May 27, 2022
The stopwatch extension had meager documentation, which this change rectifies. It also improves its production, test, and demo code. Further changes: * make sure all extensions mention their thread-safety * make sure `@Test` is always the first annotation * remove double empty line before h2 headers (because nobody except Nicolai cares) * remove "Introduction" header (it's pointless - the first paragraphs are always in intro) * replace "--" with "-" (the former is correct, but harder to stick to) * a few even smaller improvements Closes: #461 PR: #643
Bukama
pushed a commit
to Bukama/junit-pioneer
that referenced
this issue
Sep 20, 2022
/ junit-pioneer#643) The stopwatch extension had meager documentation, which this change rectifies. It also improves its production, test, and demo code. Further changes: * make sure all extensions mention their thread-safety * make sure `@Test` is always the first annotation * remove double empty line before h2 headers (because nobody except Nicolai cares) * remove "Introduction" header (it's pointless - the first paragraphs are always in intro) * replace "--" with "-" (the former is correct, but harder to stick to) * a few even smaller improvements Closes: junit-pioneer#461 PR: junit-pioneer#643
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently the Stopwatch extension's documentation falls a bit short. It should include some example outputs, e.g.: "This is how the tests annotated with
@Stopwatchlook in IntelliJ".Another idea is to say a few words about
TestReporteritself.The text was updated successfully, but these errors were encountered: