aboutsummaryrefslogtreecommitdiff
path: root/crates/test_utils/src/marks.rs
diff options
context:
space:
mode:
Diffstat (limited to 'crates/test_utils/src/marks.rs')
-rw-r--r--crates/test_utils/src/marks.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/crates/test_utils/src/marks.rs b/crates/test_utils/src/marks.rs
index d2a84643c..107432926 100644
--- a/crates/test_utils/src/marks.rs
+++ b/crates/test_utils/src/marks.rs
@@ -1,10 +1,10 @@
1//! This module implements manually tracked test coverage, which useful for 1//! This module implements manually tracked test coverage, which useful for
2//! quickly finding a test responsible for testing a particular bit of code. 2//! quickly finding a test responsible for testing a particular bit of code.
3//! 3//!
4//! See https://matklad.github.io/2018/06/18/a-trick-for-test-maintenance.html 4//! See <https://matklad.github.io/2018/06/18/a-trick-for-test-maintenance.html>
5//! for details, but the TL;DR is that you write your test as 5//! for details, but the TL;DR is that you write your test as
6//! 6//!
7//! ```no-run 7//! ```rust,no_run
8//! #[test] 8//! #[test]
9//! fn test_foo() { 9//! fn test_foo() {
10//! covers!(test_foo); 10//! covers!(test_foo);
@@ -13,7 +13,9 @@
13//! 13//!
14//! and in the code under test you write 14//! and in the code under test you write
15//! 15//!
16//! ```no-run 16//! ```rust,no_run
17//! # use test_utils::tested_by;
18//! # fn some_condition() -> bool { true }
17//! fn foo() { 19//! fn foo() {
18//! if some_condition() { 20//! if some_condition() {
19//! tested_by!(test_foo); 21//! tested_by!(test_foo);