Skip to content

Latest commit

 

History

History
10 lines (6 loc) · 521 Bytes

CODESTYLE.md

File metadata and controls

10 lines (6 loc) · 521 Bytes

Code style

This document collects some best practices we use in our code.

Expect messages

If you unwrap an Error without handling it, you should use expect and adhere to the common messages styles from the Rust Doc:

describe the reason we expect the Result should be Ok. With this style we would prefer to write: let path = std::env::var("IMPORTANT_PATH").expect("env variable IMPORTANT_PATH should be set by wrapper_script.sh");