Skip to content

Commit 0c5844b

Browse files
committed
docs(test-lexarg): Clarify subordinate types
1 parent 08e48aa commit 0c5844b

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

  • crates/libtest-lexarg/src

crates/libtest-lexarg/src/lib.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ pub struct TestOpts {
4545
pub allowed_unstable: Vec<String>,
4646
}
4747

48-
/// Whether ignored test should be run or not
48+
/// Whether ignored test should be run or not (see [`TestOpts::run_ignored`])
4949
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
5050
pub enum RunIgnored {
5151
Yes,
@@ -60,7 +60,7 @@ impl Default for RunIgnored {
6060
}
6161
}
6262

63-
/// Whether should console output be colored or not
63+
/// Whether should console output be colored or not (see [`TestOpts::color`])
6464
#[derive(Copy, Clone, Debug)]
6565
pub enum ColorConfig {
6666
AutoColor,
@@ -74,7 +74,7 @@ impl Default for ColorConfig {
7474
}
7575
}
7676

77-
/// Format of the test results output
77+
/// Format of the test results output (see [`TestOpts::format`])
7878
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
7979
pub enum OutputFormat {
8080
/// Verbose output
@@ -93,7 +93,7 @@ impl Default for OutputFormat {
9393
}
9494
}
9595

96-
/// Structure with parameters for calculating test execution time.
96+
/// Structure with parameters for calculating test execution time (see [`TestOpts::time_options`])
9797
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
9898
pub struct TestTimeOptions {
9999
/// Denotes if the test critical execution time limit excess should be considered
@@ -124,7 +124,7 @@ impl Default for TestTimeOptions {
124124
}
125125
}
126126

127-
/// Structure denoting time limits for test execution.
127+
/// Structure denoting time limits for test execution (see [`TestTimeOptions`])
128128
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
129129
pub struct TimeThreshold {
130130
pub warn: std::time::Duration,
@@ -177,7 +177,9 @@ impl TimeThreshold {
177177
}
178178
}
179179

180-
/// Options for the test run defined by the caller (instead of CLI arguments).
180+
/// Options for the test run defined by the caller (instead of CLI arguments) (see
181+
/// [`TestOpts::options`])
182+
///
181183
/// In case we want to add other options as well, just add them in this struct.
182184
#[derive(Copy, Clone, Debug, Default)]
183185
pub struct Options {

0 commit comments

Comments
 (0)