 {Emitter, Disposable} = require 'event-kit'
 Notification = require '../src/notification'
 
-# Experimental: Allows messaging the user. This will likely change, dont use
-# quite yet!
+# Public: A notification manager used to create {Notification}s to be shown
+# to the user.
 module.exports =
 class NotificationManager
   constructor: ->

  Section: Adding Notifications
  ###

  addSuccess: (message, options) ->
    @addNotification(new Notification('success', message, options))

  addInfo: (message, options) ->
    @addNotification(new Notification('info', message, options))

  addWarning: (message, options) ->
    @addNotification(new Notification('warning', message, options))

  addError: (message, options) ->
    @addNotification(new Notification('error', message, options))

  addFatalError: (message, options) ->
    @addNotification(new Notification('fatal', message, options))


  Section: Events
  ###

  # Public: Invoke the given callback after a notification has been added.
  #
  # * `callback` {Function} to be called after the notification is added.
  #   * `notification` The {Notification} that was added.
  #
  # Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.
  onDidAddNotification: (callback) ->
    @emitter.on 'did-add-notification', callback

