Skip to content

Commit 8d66fd4

Browse files
committed
update manual config doc
1 parent a497b81 commit 8d66fd4

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/docs/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ tests-root = "tests"
1616
test-framework = "pytest"
1717
formatter-cmds = ["black $file"]
1818
# optional configuration
19+
benchmarks-root = "tests/benchmarks" # Required when running with --benchmark
1920
ignore-paths = ["my_module/build/"]
2021
pytest-cmd = "pytest"
2122
disable-imports-sorting = false
@@ -29,6 +30,7 @@ Required Options:
2930
- `test-framework`: The test framework you use for your project. Codeflash supports `pytest` and `unittest`.
3031

3132
Optional Configuration:
33+
- `benchmarks-root`: The directory where your benchmarks are located. Codeflash will use this directory to discover existing benchmarks. Note that this option is required when running with `--benchmark`.
3234
- `ignore-paths`: A list of paths withing the `module-root` to ignore when optimizing code. Codeflash will not optimize code in these paths. Useful for ignoring build directories or other generated code. You can also leave this empty if not needed.
3335
- `pytest-cmd`: The command to run your tests. Defaults to `pytest`. You can specify extra commandline arguments here for pytest.
3436
- `formatter-cmds`: The command line to run your code formatter or linter. Defaults to `["black $file"]`. In the command line `$file` refers to the current file being optimized. The assumption with using tools here is that they overwrite the same file and returns a zero exit code. You can also specify multiple tools here that run in a chain as a toml array. You can also disable code formatting by setting this to `["disabled"]`.

0 commit comments

Comments
 (0)