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

Replace extension with argument converter in byte array converter docs #751

Merged
merged 1 commit into from Sep 1, 2023

Conversation

scordio
Copy link
Contributor

@scordio scordio commented Sep 1, 2023

As mentioned in #742 (comment), I propose to use argument converter instead of extension in the @NumberToByteArrayConversion docs as ArgumentConverter doesn't extend Extension.

Proposed commit message:

Use argument converter in `@NumberToByteArrayConversion` docs (#734 / #751)

Uses argument converter term in `@NumberToByteArrayConversion` docs.

See: #734
PR: #751

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)

@scordio scordio marked this pull request as ready for review September 1, 2023 09:12
@Michael1993 Michael1993 merged commit d648b46 into junit-pioneer:main Sep 1, 2023
11 checks passed
@scordio scordio deleted the docs-update branch September 1, 2023 15:49
Michael1993 pushed a commit that referenced this pull request Sep 3, 2023
…751)

Uses argument converter term in `@NumberToByteArrayConversion` docs.

See: #734
PR: #751
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants