From 9f751362e817b7b825633e12899c22a4c20319ae Mon Sep 17 00:00:00 2001
From: Moritz <mosum@google.com>
Date: Tue, 10 Dec 2024 11:14:24 +0100
Subject: [PATCH] Changes as per review

---
 pkgs/canary/bin/canary.dart | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/pkgs/canary/bin/canary.dart b/pkgs/canary/bin/canary.dart
index 4cd562ff..ca3221ea 100644
--- a/pkgs/canary/bin/canary.dart
+++ b/pkgs/canary/bin/canary.dart
@@ -52,6 +52,8 @@ Future<void> main(List<String> arguments) async {
 
 enum Level { solve, analyze, test }
 
+/// A mapping of a package to application test results.
+///
 /// The result of sending a canary into the mine. Stores the [package] which was
 /// tested with its new [version] as well as the [shaftAirQualities] holding the
 /// information on each individual [Application] which was tested against.
@@ -69,6 +71,8 @@ class MineAirQuality {
 MineAirQuality(package: $package, version: $version, shaftAirQualities: $shaftAirQualities)''';
 }
 
+/// Test results for a specific application.
+///
 /// This stores the result of testing the canary against an individual
 /// [Application].
 class ShaftAirQuality {