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

Homogenize and improve Javadoc, particularly <p> tags: #787

Merged
merged 3 commits into from Nov 9, 2023

Conversation

nipafx
Copy link
Member

@nipafx nipafx commented Nov 7, 2023

Proposed commit message:

Homogenize and improve Javadoc, particularly `<p>` tags:

* leading paragraphs don't need `<p>`/`</p>` tags
* all subequent paragraphs need `<p>` *and* `</p>` tags
* `<p>` and `</p>` tags are on the same lines as the content
* paragraphs end with an end-of-sentence symbol
* a paragraph is always surrounded by empty lines (one before
 and one after)
* move `<ul>` blocks out of `<p>` blocks

Other changes:

* remove `<code>` tags when they don't contain code
* fix capitalization of feature names (they're no proper nouns)
* probably more that I forgot

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 (general)

  • 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)

Code (new package)

  • The new package is exported in module-info.java
  • The new package is also present in the tests
  • The new package is opened for reflection to JUnit 5 in module-info.java
  • The new package is listed in the contribution guide

Contributing

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

* leading paragraphs don't need <p>/</p> tags
* all subequent paragraphs need <p> *and* </p> tags
* <p> and </p> tags are on the same lines as the content
* paragraphs end with an end-of-sentence symbol
* a pararaph is always surronded by two empty lines
* move <ul> blocks out of <p> blocks

Other changes:

* remove <code> tags when they don't contain code
* fix capitalization of feature names (they're no proper nouns)
* probably more that I forgot
@nipafx nipafx added the full-build Triggers full build suite on PR label Nov 9, 2023
@Bukama Bukama self-requested a review November 9, 2023 19:16
Copy link
Member

@Bukama Bukama left a comment

Choose a reason for hiding this comment

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

I really like such clean up work! Thank you very much.
Changed your proposed commit message about "the two lines" as communicated on stream and will merge now.

@Bukama Bukama merged commit 31e7e03 into main Nov 9, 2023
44 checks passed
@Bukama Bukama deleted the lab/javadoc-polish branch November 9, 2023 19:31
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.

None yet

2 participants