hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-26 01:05:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from docs review

Browse Source 
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
This commit is contained in:
Jami
2025-03-25 07:19:39 -04:00
committed by GitHub
parent b9bf192c09
commit e169c21f8b
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
java/ql/src/Likely Bugs/Frameworks/JUnit/JUnit5MissingNestedAnnotation.md
View File

@@ -1,6 +1,6 @@
## Overview
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.
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.
## Recommendation

2
java/ql/src/Likely Bugs/Frameworks/JUnit/JUnit5MissingNestedAnnotation.ql
View File

@@ -3,7 +3,7 @@
* @previous-id java/junit5-non-static-inner-class-missing-nested-annotation
* @name Missing `@Nested` annotation on JUnit 5 inner test class
* @description A JUnit 5 inner test class that is missing a `@Nested` annotation will be
* excluded from execution and it may indicate a misunderstanding from the
* excluded from execution and may indicate a mistake from the
* programmer.
* @kind problem
* @precision very-high