From 6b87b4c3a9d90f54cadb0afbf3c7d9ecbd2e143f Mon Sep 17 00:00:00 2001
From: Erich Gubler <erichdongubler@gmail.com>
Date: Fri, 27 Oct 2023 12:00:24 -0400
Subject: [PATCH] docs(cli): add description to `shared::Expectation`

---
 src/bin/moz-webgpu-cts/shared.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/bin/moz-webgpu-cts/shared.rs b/src/bin/moz-webgpu-cts/shared.rs
index d4d9bf9..20b05d2 100644
--- 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),