Skip to content

Commit 805cd74

Browse files
docs: document TestScope APIs
1 parent 9a577a2 commit 805cd74

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

moz-webgpu-cts/src/shared.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -662,18 +662,22 @@ impl Display for MetadataTestPathError<'_> {
662662
}
663663
}
664664

665+
/// A browser supported by [super::main], used for [`TestPath`]s.
665666
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, ValueEnum)]
666667
pub(crate) enum Browser {
667668
Firefox,
668669
Servo,
669670
}
670671

672+
/// Symbolically represents a file root from which tests and metadata are based. Scopes are based
673+
/// on a specific [`Browser`].
671674
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
672675
pub(crate) enum TestScope {
673676
Firefox(FirefoxTestScope),
674677
Servo(ServoTestScope),
675678
}
676679

680+
/// Subset of [`TestScope`] for [`Browser::Firefox`].
677681
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
678682
pub(crate) enum FirefoxTestScope {
679683
/// A public test available at some point in the history of [WPT upstream]. Note that while
@@ -691,8 +695,10 @@ impl From<FirefoxTestScope> for TestScope {
691695
}
692696
}
693697

698+
/// Subset of [`TestScope`] for [`Browser::Servo`].
694699
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
695700
pub(crate) enum ServoTestScope {
701+
/// A WebGPU CTS test vendored into Servo's source tree.
696702
WebGpu,
697703
}
698704

0 commit comments

Comments
 (0)