treewide: documentation on exported functions should start with their name
Change-Id: Iea3e929bed743d7edfbf5b54bbaa31796aeaaadd
Reviewed-on: https://review.monogon.dev/c/monogon/+/3027
Vouch-Run-CI: Tim Windelschmidt <tim@monogon.tech>
Tested-by: Jenkins CI
Reviewed-by: Serge Bazanski <serge@monogon.tech>
diff --git a/metropolis/pkg/bootparam/bootparam.go b/metropolis/pkg/bootparam/bootparam.go
index 3d6b7fa..240abf3 100644
--- a/metropolis/pkg/bootparam/bootparam.go
+++ b/metropolis/pkg/bootparam/bootparam.go
@@ -33,7 +33,7 @@
}
}
-// Trim spaces as defined by Linux from the left of the string.
+// TrimLeftSpace spaces as defined by Linux from the left of the string.
// This is only exported for tests, do not use this. Because of import loops
// as well as cgo restrictions this cannot be an internal function used by
// tests.