Merge pull request #75 from ngrok/phil/docs-refactor

Comments refactor for docs
ngrok · Oct 16, 2023 · f7291f3 · f7291f3
2 parents aa219ba + 98c62b9
commit f7291f3
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/config/http.go b/config/http.go
@@ -18,7 +18,7 @@ func (of httpOptionFunc) ApplyHTTP(cfg *httpOptions) {
 	of(cfg)
 }
 
-// Construct a new set of HTTP tunnel options.
+// HTTPEndpoint constructs a new set options for a HTTP endpoint.
 func HTTPEndpoint(opts ...HTTPEndpointOption) Tunnel {
 	cfg := httpOptions{}
 	for _, opt := range opts {

diff --git a/config/labeled.go b/config/labeled.go
@@ -16,7 +16,7 @@ func (of labeledOptionFunc) ApplyLabeled(cfg *labeledOptions) {
 	of(cfg)
 }
 
-// Construct a new set of Labeled tunnel options.
+// LabeledTunnel constructs a new set options for a labeled Edge.
 func LabeledTunnel(opts ...LabeledTunnelOption) Tunnel {
 	cfg := labeledOptions{}
 	for _, opt := range opts {

diff --git a/config/tcp.go b/config/tcp.go
@@ -16,7 +16,7 @@ func (of tcpOptionFunc) ApplyTCP(cfg *tcpOptions) {
 	of(cfg)
 }
 
-// Construct a new set of HTTP tunnel options.
+// TCPEndpoint constructs a new set options for a TCP endpoint.
 func TCPEndpoint(opts ...TCPEndpointOption) Tunnel {
 	cfg := tcpOptions{}
 	for _, opt := range opts {

diff --git a/config/tls.go b/config/tls.go
@@ -18,7 +18,7 @@ func (of tlsOptionFunc) ApplyTLS(cfg *tlsOptions) {
 	of(cfg)
 }
 
-// Construct a new set of HTTP tunnel options.
+// TLSEndpoint constructs a new set options for a TLS endpoint.
 func TLSEndpoint(opts ...TLSEndpointOption) Tunnel {
 	cfg := tlsOptions{}
 	for _, opt := range opts {