File tree Expand file tree Collapse file tree 1 file changed +7
-1
lines changed Expand file tree Collapse file tree 1 file changed +7
-1
lines changed Original file line number Diff line number Diff line change @@ -12,7 +12,13 @@ when failures occur. Eliminating these modes of failure in omics development and
12
12
analyses is one of the primary reasons the project was created.
13
13
14
14
To that end, correctness should be considered the highest priority of crates in the
15
- ` rust-seq ` stack—** even at the cost of performance** .
15
+ ` rust-seq ` stack—** even at the cost of performance** .
16
+
17
+ In situations where performance is critical, developers should provide both a _ safe_
18
+ and _ unsafe_ interface, clearly documenting the pre-requisites for the _ unsafe_ interface
19
+ at the API level. Likewise, any ` unsafe ` code should be explicity documented (in the code)
20
+ with a comment beginning with the token ` SAFETY: ` , that explicitly describes why the code
21
+ in the unsafe block is expected to operate correctly and not invoke undefined behavior.
16
22
17
23
## Performant
18
24
You can’t perform that action at this time.
0 commit comments