Skip to content

Commit 00c2dee

Browse files
committed
Improve design doc
1 parent a996fe2 commit 00c2dee

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

docs/UtUtilsClass.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ Previously UnitTestBot generated _utility methods_ for each test class when they
1212

1313
For now UnitTestBot provides a special `UtUtils` class containing all _utility methods_ if at least one test class needs some of them. This class is generated once and the specific methods are imported from it if necessary. No need for _utility methods_ — no `UtUtils` class is generated.
1414

15+
We create a separate `UtUtils` class for each supported codegen language (is this class is required).
16+
1517
## What does it look like
1618

17-
Here is an example of a comment inherent to every `UtUtils` class:
19+
Here is the documentation inherent to every `UtUtils` class:
1820

19-
<img width="494" alt="ututils" src="https://user-images.githubusercontent.com/64418523/196719780-2603f141-e922-40fc-9a0a-533aaacc5c49.png">
21+
![Documentation](../images/utbot_ututils_2.0.png)
2022

2123
As one can see, the comment mentions two characteristics of the `UtUtils` class:
2224

@@ -39,7 +41,7 @@ rely on the proper methods from `UtUtils` class.
3941

4042
## Where to find it
4143

42-
`UtUtils` class is usually located in the chosen **Test sources root** near the generated test classes.
44+
`UtUtils` class is usually located in the chosen **Test sources root** near the generated test classes, it's package is named after the selected codegen language.
4345

4446
## How to test
4547

docs/images/utbot_ututils_2.0.png

14.9 KB
Loading

0 commit comments

Comments
 (0)