Skip to content

Commit 6bc2497

Browse files
committed
Update docs
1 parent c5254dc commit 6bc2497

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/docs/codeflash-concepts/how-codeflash-works.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,12 @@ Codeflash currently only runs tests that directly call the target function in th
2121

2222
## Optimization Generation
2323

24-
To optimize code, Codeflash first gathers all necessary context from the codebase. It then calls our backend to generate several candidate optimizations. These are called "candidates" because their speed and correctness haven't been verified yet. Both properties will be verified in later steps.
25-
24+
To optimize code, Codeflash first gathers all necessary context from the codebase. It also line-profiles your code to understand where the bottlenecks might reside. It then calls our backend to generate several candidate optimizations. These are called "candidates" because their speed and correctness haven't been verified yet. Both properties will be verified in later steps.
2625
## Verification of correctness
2726

2827
![Verification](/img/codeflash_arch_diagram.gif)
2928

30-
The goal of correctness verification is to ensure that when the original code is replaced by the new code, there are no behavioral changes in the code and the rest of the system. This means the replacement should be completely safe.
29+
The goal of correctness verification is to ensure that when the new code replaces the original code, there are no behavioral changes in the code and the rest of the system. This means the replacement should be completely safe.
3130

3231
To verify correctness, Codeflash calls the function with numerous inputs, confirming that the new function behaves identically to the original.
3332

@@ -60,4 +59,4 @@ Codeflash implements several techniques to measure code performance accurately.
6059

6160
## Creating Pull Requests
6261

63-
Once an optimization passes all checks, Codeflash creates a pull request through the Codeflash GitHub app directly in your repository. The pull request includes the new code, the speedup percentage, an explanation of the optimization, test statistics including coverage, and the test content itself. You can review and merge the new code if it meets your standards. Feel free to modify the code as needed—we welcome your improvements!
62+
Once an optimization passes all checks, Codeflash creates a pull request through the Codeflash GitHub app directly in your repository. The pull request includes the new code, the speedup percentage, an explanation of the optimization, test statistics including coverage, and the test content itself. You can review and merge the new code if it meets your standar

0 commit comments

Comments
 (0)