docs(cli): add description to shared::Expectation

erichdongubler-mozilla · Oct 27, 2023 · 6b87b4c · 6b87b4c
1 parent 7f2c92f
commit 6b87b4c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/bin/moz-webgpu-cts/shared.rs b/src/bin/moz-webgpu-cts/shared.rs
@@ -2,6 +2,10 @@ use std::{collections::BTreeMap};
 
 use crate::metadata::{BuildProfile, Platform};
 
+/// A set of expected outcomes in a [`Test`] or [`Subtest`].
+///
+/// [`Test`]: crate::metadata::Test
+/// [`Subtest`]: crate::metadata::Subtest
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub enum Expectation<Out> {
     Permanent(Out),