From 6ca9766897a9578a95834ecb13f84819cad005a5 Mon Sep 17 00:00:00 2001
From: Sebastiaan van Stijn <github@gone.nl>
Date: Tue, 4 Feb 2025 11:09:31 +0100
Subject: [PATCH] cli/connhelper/ssh: improve GoDoc for ParseURL

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
---
 cli/connhelper/ssh/ssh.go | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/cli/connhelper/ssh/ssh.go b/cli/connhelper/ssh/ssh.go
index fb4c911105..61b95b9ff4 100644
--- a/cli/connhelper/ssh/ssh.go
+++ b/cli/connhelper/ssh/ssh.go
@@ -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 {