New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Polish documentation, particularly Stopwatch #643
Merged
Merged
Conversation
This file contains 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
nipafx
force-pushed
the
issue/461-stopwatch-documentation
branch
from
May 26, 2022 15:21
3ea07ee
to
8f5f090
Compare
Michael1993
reviewed
May 27, 2022
Michael1993
reviewed
May 27, 2022
Co-authored-by: Mihály Verhás <misi.verhas@gmail.com>
Otherwise all good? |
If so, feel free to merge. |
Michael1993
reviewed
May 27, 2022
Michael1993
reviewed
May 27, 2022
Michael1993
requested changes
May 27, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Otherwise good.
Michael1993
approved these changes
May 27, 2022
Bukama
pushed a commit
to Bukama/junit-pioneer
that referenced
this pull request
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
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.
Proposed commit message:
PR checklist
The following checklist shall help the PR's author, the reviewers and maintainers to ensure the quality of this project.
It is based on our contributors guidelines, especially the "writing code" section.
It shall help to check for completion of the listed points.
If a point does not apply to the given PR's changes, the corresponding entry can be simply marked as done.
Documentation (general)
.adoc
file in thedocs
folder, e.g.docs/report-entries.adoc
.adoc
file references demo insrc/demo/java
instead of containing code blocks as text.adoc
files)Documentation (new extension)
docs/docs-nav.yml
navigation has an entry for the new extensionpackage-info.java
contains information about the new extensionCode
Contributing
README.md
mentions the new contribution (real name optional)