cli/connhelper/ssh: improve GoDoc for ParseURL

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2025-04-17 21:34:18 +02:00
parent 126713648e
commit 6ca9766897
1 changed files with 3 additions and 1 deletions
@@ -7,7 +7,9 @@ import (
 	"github.com/pkg/errors"
 )

-// ParseURL parses URL
+// ParseURL creates a [Spec] from the given ssh URL. It returns an error if
+// the URL is using the wrong scheme, contains fragments, query-parameters,
+// or contains a password.
 func ParseURL(daemonURL string) (*Spec, error) {
 	u, err := url.Parse(daemonURL)
 	if err != nil {