Multiple documentation fixes #136
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
Contributor
Bananeweizen
commented
Jan 9, 2023
Bananeweizen
commented
- document more static code analysis tools that can find wrong assertions
- fix grammar, typos and punctuation to be consistent for English language
- the comments in Java are called "Javadoc" (with uppercase J), only the tool to create them is called "javadoc" (with lowercase J).
- lists must be separated by an empty line from previous content, otherwise they don't render correctly
* document more static code analysis tools that can find wrong assertions * fix grammar, typos and punctuation to be consistent for English language * the comments in Java are called "Javadoc" (with uppercase J), only the tool to create them is called "javadoc" (with lowercase J). * lists must be separated by an empty line from previous content, otherwise they don't render correctly
Bananeweizen
force-pushed
the
multiple_cleanups
branch
from
9dbe200
to
3fa7f04
Compare
# Conflicts: # src/docs/asciidoc/user-guide/assertj-core-release-notes.adoc # src/docs/asciidoc/user-guide/assertj-guava-release-notes.adoc
scordio
reviewed
Oct 10, 2023
| The main trap is to pass the object under test to `assertThat()` and forget to call an assertion afterward. | ||
| This misuse can be detected by multiple static code analysis tools: | ||
|
|
||
| * https://spotbugs.github.io/[SpotBugs] or http://findbugs.sourceforge.net/[Findbugs] with the https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html#rv-method-ignores-return-value-is-this-ok-rv-return-value-ignored-inferred[RV_RETURN_VALUE_IGNORED_INFERRED] rule |
There was a problem hiding this comment.
Do we still want/need to mention FindBugs?
The current version of FindBugs is 3.0.1, released on 13:05:33 EST, 06 March, 2015
There was a problem hiding this comment.
For now, I'm keeping it but I believe we could even remove it.
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.