Skip to content

Commit

Permalink
chore: update more of the notes
Browse files Browse the repository at this point in the history
  • Loading branch information
qartik committed Nov 11, 2024
1 parent b38aa00 commit 41d335b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
4 changes: 2 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ We use `rustfmt` to enforce a consistent coding style. The CI will fail if the c
To format your code, run:

```bash
cargo format
cargo fmt
```

We also use various linters to catch common mistakes and enforce best practices. To run these, see [our CI config](./.github/workflows/ci-rs.yml). TODO Provide a better way, contributions welcome.
Expand All @@ -66,7 +66,7 @@ cargo install cargo-llvm-cov
Then run the tests, see [our CI config](/.github/workflows/ci-rs.yml).

```bash
just coverage
cargo llvm-cov --lcov --output-path lcov.info
```

This will generate a coverage file that can be opened with your favourite coverage viewer. In VSCode, you can use
Expand Down
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ This project is licensed under Apache License, Version 2.0 ([LICENCE](LICENCE) o
[inkwell]: https://thedan64.github.io/inkwell/inkwell/index.html
[llvm-sys]: https://crates.io/crates/llvm-sys
[llvm]: https://llvm.org/
[guppy]: https://github.com/CQCL/guppylang

0 comments on commit 41d335b

Please sign in to comment.