ssh: document how to unmarshal public keys

Fixes golang/go#21491. Change-Id: I5c720f1f6c6acfa7f4cd50920f65db7e57ba3792 Reviewed-on: https://go-review.googlesource.com/95115 Run-TryBot: Han-Wen Nienhuys <[email protected]> TryBot-Result: Gobot Gobot <[email protected]> Reviewed-by: Brad Fitzpatrick <[email protected]>
golang · Feb 27, 2018 · 8c65384 · 8c65384
1 parent beaf6a3
commit 8c65384
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/ssh/keys.go b/ssh/keys.go
@@ -276,7 +276,8 @@ type PublicKey interface {
 	Type() string
 
 	// Marshal returns the serialized key data in SSH wire format,
-	// with the name prefix.
+	// with the name prefix. To unmarshal the returned data, use
+	// the ParsePublicKey function.
 	Marshal() []byte
 
 	// Verify that sig is a signature on the given data using this