summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2022-04-23 13:13:38 -0400
committerNick Gerace <nickagerace@gmail.com>2022-04-23 13:47:02 -0400
commit6d4aa0bf924a030b10a6034658407b493d9cc762 (patch)
treede506df576ac225adfbc216cb1e0ce0491074b32 /docs
parent4516907acec09ace341927c89d93d1f23c662e92 (diff)
downloadgfold-6d4aa0bf924a030b10a6034658407b493d9cc762.zip
Bolster loose bench to provide better results
Loose bench: - Bolster loose bench to calculate more runs with averages - Alternate order at the halfway mark of total runs for loose bench - Display run averages and global duration for loose bench - Add TODO for loose bench to track average deviation (i.e. how consistently does gfold perform across runs?) - Add module comment for loose bench explaining its purpose Misc: - Add TargetOption enum for processing target entries - Name reports and target varaibles with more specificity - Add fix commands to DEVELOPING - Misc updates to Cargo.lock - Update to 4.0.0-rc.3 Result: - Only use "anyhow::Result" when there is more than one error type Bug fix: - Add current dir to scripts to ensure gfold is being built Signed-off-by: Nick Gerace <nickagerace@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/DEVELOPING.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
index 23b6607..51113ac 100644
--- a/docs/DEVELOPING.md
+++ b/docs/DEVELOPING.md
@@ -29,6 +29,13 @@ cargo build --all-targets
> cargo nextest run
> ```
+If you'd like to mass "fix" everything, you should commit/save existing work and execute the following:
+
+```shell
+cargo fix --all-targets --all-features --allow-dirty --allow-staged
+cargo clippy --fix --all-features --all-targets --allow-dirty --allow-staged
+```
+
## Performance Checks
Navigate to the [README in the `scripts` directory](../scripts/README.md) for more information on
@@ -38,7 +45,6 @@ how to run performance checks.
The following checks are optional and should be run occasionally.
-
```shell
# This command requires a nightly toolchain to be installed.
cargo +nightly udeps