Skip to content

Commit dad3080

Browse files
docs: document TestScope APIs
1 parent 906ce3c commit dad3080

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

moz-webgpu-cts/src/shared.rs

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

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

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

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

697+
/// Subset of [`TestScope`] for [`Browser::Servo`].
693698
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
694699
pub(crate) enum ServoTestScope {
695700
WebGpu,

0 commit comments

Comments
 (0)