Skip to content

Commit ebdb569

Browse files
authored
CodeGenerationAndRendering.md -- typos fixed (#1571)
* Typos fixed
1 parent 7402d71 commit ebdb569

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/CodeGenerationAndRendering.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Code generation and rendering
22

3-
Code generation and rendering is a part of test generation process in UnitTestBot (find the overall picture in the
3+
Code generation and rendering are a part of the test generation process in UnitTestBot (find the overall picture in the
44
[UnitTestBot architecture
55
overview](https://github.com/UnitTestBot/UTBotJava/blob/main/docs/OverallArchitecture.md)).
6-
UnitTestBot gets the synthetic representation of generated test cases from the fuzzer or the symbolic engine. This representation, or model, is
7-
implemented in the `UtExecution` class.
6+
UnitTestBot gets the synthetic representation of generated test cases from the fuzzer or the symbolic engine.
7+
This representation (or model) is implemented in the `UtExecution` class.
88

99
The `codegen` module generates the real test code based on this `UtExecution` model and renders it in a
1010
human-readable form in accordance with the requested configuration (considering programming language, testing
@@ -213,7 +213,7 @@ The further AST levels are created similarly. The AST leaves are `CgLiteral`, `C
213213
The below-mentioned functionality is implemented in `CgMethodConstructor`.
214214

215215
To create a test method:
216-
* store the initial values of the static fields and perform the seven steps for creating test method body mentioned later,
216+
* store the initial values of the static fields and perform the seven steps for creating test method body mentioned later;
217217
* if the static field values undergo changes, perform these seven steps in the `try` block and recover these values in the `finally` block accordingly.
218218

219219
To create test method body:
@@ -225,14 +225,14 @@ To create test method body:
225225
6. generate result assertions
226226
7. for successful tests, generate field state assertions
227227

228-
_Note:_ generating assertions has pitfalls. In primitive cases like comparing two integers, we can use the standard
228+
_Note:_ generating assertions has pitfalls. In primitive cases, like comparing two integers, we can use the standard
229229
assertions of a selected test framework. To compare two objects of an arbitrary type, we need a
230230
custom implementation of equality assertion, e.g. using `deepEquals()`. The `deepEquals()` method compares object
231231
structures field by field. The method is recursive: if the current field is not of the primitive type, we call
232232
`deepEquals()` for this field. The maximum recursion depth is limited.
233233

234234
For the parameterized tests
235-
- we do not support mocking, so we do not set up the initial environment,
235+
- we do not support mocking, so we do not set up the initial environment;
236236
- we do not generate field state assertions.
237237

238238
`UtExecution` usually represents a single test scenario, and one `UtExecution` instance is used to create a single
@@ -256,7 +256,7 @@ From the group of `UtExecution` elements, we take the first successful execution
256256

257257
## Renderer
258258

259-
We have a general approach for rendering the code of test classes. `UtUtils` class is rendered differently: we
259+
We have a general approach for rendering the code of test classes. `UtUtils` class is rendered differently: we
260260
hardcode the required method implementations for the specific code generation language.
261261

262262
All the renderers implement `CgVisitor` interface. It has a separate `visit()` method for each supported
@@ -284,7 +284,7 @@ While constructing the test class, we create test generation reports. It contain
284284
number of generated tests, the number of successful tests, etc. It also may contain information on potential problems
285285
like trying to use mocks when mocking framework is not installed.
286286

287-
The report is represented as an HTML-string allowing to include clickable links.
287+
The report is an HTML string with clickable links.
288288

289289
_Note:_ no test generation reports are created for parameterized tests.
290290

0 commit comments

Comments
 (0)