Skip to content

Commit e169c21

Browse files
jcogs33mchammer01
andauthored
Apply suggestions from docs review
Co-authored-by: mc <[email protected]>
1 parent b9bf192 commit e169c21

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

java/ql/src/Likely Bugs/Frameworks/JUnit/JUnit5MissingNestedAnnotation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Overview
22

3-
JUnit tests are grouped in a class, and starting from JUnit 5 users can group the test classes in a bigger class so they can share the local environment of the enclosing class. While this helps to organize the unit tests and foster code reuse, if an inner test class is not annotated with `@Nested`, the unit tests in it will fail to execute during builds.
3+
JUnit tests are grouped in a class, and starting from JUnit 5, users can group the test classes in a larger class so they can share the local environment of the enclosing class. While this helps organize the unit tests and foster code reuse, if an inner test class is not annotated with `@Nested`, the unit tests in it will fail to execute during builds.
44

55
## Recommendation
66

java/ql/src/Likely Bugs/Frameworks/JUnit/JUnit5MissingNestedAnnotation.ql

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* @previous-id java/junit5-non-static-inner-class-missing-nested-annotation
44
* @name Missing `@Nested` annotation on JUnit 5 inner test class
55
* @description A JUnit 5 inner test class that is missing a `@Nested` annotation will be
6-
* excluded from execution and it may indicate a misunderstanding from the
6+
* excluded from execution and may indicate a mistake from the
77
* programmer.
88
* @kind problem
99
* @precision very-high

0 commit comments

Comments
 (0)