chore: clarified a godoc comment

xmidt-org · Jul 18, 2023 · 844a3a8 · 844a3a8
1 parent 063787f
commit 844a3a8
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/arrangehttp/listener.go b/arrangehttp/listener.go
@@ -65,8 +65,8 @@ func (f DefaultListenerFactory) Listen(ctx context.Context, server *http.Server)
  return l, nil
 }
 
-// NewListener encapsulates the logic for creating a net.Listener for a server. Typically,
-// this function should be called from within an start fx.Hook.
+// NewListener encapsulates the logic for creating a net.Listener for a server.
+// This function should be called from within a start hook, typically via fx.Hook.OnStart.
 //
 // The ListenerFactory may be nil, in which case an instance of DefaultListenerFactory will be used.
 func NewListener(ctx context.Context, lf ListenerFactory, server *http.Server, lm ...ListenerMiddleware) (l net.Listener, err error) {