diff options
| -rw-r--r-- | sx-compose.el | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/sx-compose.el b/sx-compose.el index 273e02d..f5aef79 100644 --- a/sx-compose.el +++ b/sx-compose.el @@ -19,6 +19,16 @@ ;;; Commentary: +;; This file defines `sx-compose-mode' and its auxiliary functions and +;; variables. In order to use `sx-compose-mode', it is adamant that +;; the variable `sx-compose--send-function' be set. Otherwise it's +;; just a regular markdown buffer. +;; +;; In order to help avoid mistakes, there is the function +;; `sx-compose-create'. This is the preferred way of activating the +;; mode. It creates a buffer, activates the major mode, and sets the +;; `send-function' variable according to the arguments it is given. + ;;; Code: (require 'markdown-mode) |