treewide: documentation on exported types should start with their name
Change-Id: I2e25157459ecc55421138e9fb6a15de5024d00fd
Reviewed-on: https://review.monogon.dev/c/monogon/+/3028
Reviewed-by: Serge Bazanski <serge@monogon.tech>
Vouch-Run-CI: Tim Windelschmidt <tim@monogon.tech>
Tested-by: Jenkins CI
diff --git a/metropolis/pkg/pstore/pstore.go b/metropolis/pkg/pstore/pstore.go
index 3958498..610f565 100644
--- a/metropolis/pkg/pstore/pstore.go
+++ b/metropolis/pkg/pstore/pstore.go
@@ -52,7 +52,7 @@
}, nil
}
-// A reassembled kernel message buffer dump from pstore.
+// KmsgDump reassembled a kernel message buffer dump from pstore.
type KmsgDump struct {
// The reason why the dump was created. Common values include "Panic" and
// "Oops", but depending on the setting `printk.always_kmsg_dump` and