Skip to content

Commit 6ca9766

Browse files
committed
cli/connhelper/ssh: improve GoDoc for ParseURL
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent 1267136 commit 6ca9766

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

cli/connhelper/ssh/ssh.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ import (
77
"github.com/pkg/errors"
88
)
99

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

0 commit comments

Comments
 (0)