Merge pull request #135 from ngrok/josh/forwards-to-links

config: add link to `ListenAndForward` in `WithForwardsTo`
ngrok · Nov 2, 2023 · 8b5875b · 8b5875b
2 parents efac7a9 + 04b4b3c
commit 8b5875b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/config/forwards_to.go b/config/forwards_to.go
@@ -11,6 +11,10 @@ type forwardsToOption string
 // WithForwardsTo sets the ForwardsTo string for this tunnel.
 // This can be viewed via the API or dashboard.
 //
+// This overrides the default process info if using
+// [golang.ngrok.com/ngrok.Listen], and is in turn overridden by the url
+// provided to [golang.ngrok.com/ngrok.ListenAndForward].
+//
 // https://ngrok.com/docs/api/resources/tunnels/#tunnel-fields
 func WithForwardsTo(meta string) Options {
 	return forwardsToOption(meta)