Skip to content
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 8 commits into from May 27, 2022

Conversation

nipafx
Copy link
Member

@nipafx nipafx commented May 26, 2022

Proposed commit message:

Polish documentation and code, particularly Stopwatch (#461 / #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 me 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

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)

  • There is documentation (Javadoc and site documentation; added or updated)
  • There is implementation information to describe why a non-obvious source code / solution got implemented
  • Site documentation has its own .adoc file in the docs folder, e.g. docs/report-entries.adoc
  • Site documentation in .adoc file references demo in src/demo/java instead of containing code blocks as text
  • Only one sentence per line (especially in .adoc files)
  • Javadoc uses formal style, while sites documentation may use informal style

Documentation (new extension)

  • The docs/docs-nav.yml navigation has an entry for the new extension
  • The package-info.java contains information about the new extension

Code

  • Code adheres to code style, naming conventions etc.
  • Successful tests cover all changes
  • There are checks which validate correct / false usage / configuration of a functionality and there are tests to verify those checks
  • Tests use AssertJ or our own PioneerAssert (which are based on AssertJ)

Contributing

  • A prepared commit message exists
  • The list of contributions inside README.md mentions the new contribution (real name optional)

@nipafx nipafx requested review from Michael1993 and Bukama May 26, 2022 15:14
@nipafx nipafx linked an issue May 26, 2022 that may be closed by this pull request
@nipafx nipafx force-pushed the issue/461-stopwatch-documentation branch from 3ea07ee to 8f5f090 Compare May 26, 2022 15:21
docs/stopwatch.adoc Outdated Show resolved Hide resolved
Co-authored-by: Mihály Verhás <misi.verhas@gmail.com>
@nipafx
Copy link
Member Author

nipafx commented May 27, 2022

Otherwise all good?

@nipafx
Copy link
Member Author

nipafx commented May 27, 2022

If so, feel free to merge.

@nipafx nipafx added the full-build Triggers full build suite on PR label May 27, 2022
docs/vintage-test.adoc Outdated Show resolved Hide resolved
docs/stopwatch.adoc Outdated Show resolved Hide resolved
Copy link
Member

@Michael1993 Michael1993 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise good.

@Michael1993 Michael1993 merged commit 79e35de into main May 27, 2022
@Michael1993 Michael1993 deleted the issue/461-stopwatch-documentation branch May 27, 2022 12:40
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
Labels
full-build Triggers full build suite on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation of the Stopwatch extension
2 participants