diff options
| author | Sebastian Büttner <sebastian.buettner@softwareag.com> | 2021-03-31 15:57:42 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-31 15:57:42 +0200 |
| commit | 958197135000eb9da7cc65a38c256e52fa1f8f32 (patch) | |
| tree | a294b99625dbb939542e0da40b17e1f1a37a72a9 /CODING_GUIDELINES.md | |
| parent | bd3ac47244529e2aba02cdcc113d315351f55b65 (diff) | |
fixing command for formating
Diffstat (limited to 'CODING_GUIDELINES.md')
| -rw-r--r-- | CODING_GUIDELINES.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 39c663eb..42c5af0c 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -8,7 +8,7 @@ Avoid using unsafe code. ## Code formatting Always use rustfmt before you commit as your code won't pass CI pipeline if rustfmt is not applied. We adhere to default settings. -```$ clippy fmt``` +```$ cargo fmt``` ## Code analysis @@ -25,4 +25,4 @@ Error handling suggestions follow the [Rust book guidance](https://doc.rust-lan * Panic (the code should not panic) * `unwrap()` - Unwrap should only be used for mutexes (e.g. `lock().unwrap()`) and test code. For all other use cases, prefer `expect()`. The only exception is if the error message is custom-generated, in which case use `.unwrap_or_else(|| panic!("error: {}", foo))` * `expect()` - Expect should be invoked when a system invariant is expected to be preserved. `expect()` is preferred over `unwrap()` and should contain a detailed error message on failure in most cases. -* `assert!()` - This macro is kept in both debug/release and should be used to protect invariants of the system as necessary.
\ No newline at end of file +* `assert!()` - This macro is kept in both debug/release and should be used to protect invariants of the system as necessary. |