Improved documentation of Fatal Handlers

alt_exit.go

@@ -51,9 +51,14 @@ func Exit(code int) {
 	os.Exit(code)
 }
 
-// RegisterExitHandler adds a Logrus atexit handler, call logrus.Exit to invoke
+// RegisterExitHandler adds a Logrus Exit handler, call logrus.Exit to invoke
 // all handlers. The handlers will also be invoked when any Fatal log entry is
 // made.
+//
+// This method is useful when a caller wishes to use logrus to log a fatal
+// message but also needs to gracefully shutdown. An example usecase could be
+// closing database connections, or sending a alert that the application is
+// closing.
 func RegisterExitHandler(handler func()) {
 	handlers = append(handlers, handler)
 }