Improve skeleton docstrings
authorNoam Postavsky <npostavs@gmail.com>
Tue, 20 Dec 2016 00:49:47 +0000 (19:49 -0500)
committerNoam Postavsky <npostavs@gmail.com>
Tue, 20 Dec 2016 01:02:57 +0000 (20:02 -0500)
* lisp/skeleton.el (skeleton-end-newline): Remove mention of
`skeleton-end-hook', its default code was moved into `skeleton-insert'.
(skeleton-insert): Mention `skeleton-end-newline' and move reference to
`skeleton-end-hook' above the explanation of skeleton syntax.

lisp/skeleton.el

index 0e81e2d74c6fd76002882efb50b0f05d2fbe1a1d..1b77a095fbc711d912f36933781ad24c63324b52 100644 (file)
@@ -59,8 +59,7 @@ region.")
 (make-obsolete-variable 'skeleton-autowrap nil "24.5")
 
 (defvar skeleton-end-newline t
-  "If non-nil, make sure that the skeleton inserted ends with a newline.
-This just influences the way the default `skeleton-end-hook' behaves.")
+  "If non-nil, make sure that the skeleton inserted ends with a newline.")
 
 (defvar skeleton-end-hook nil
   "Hook called at end of skeleton but before going to point of interest.
@@ -187,6 +186,10 @@ The optional third argument STR, if specified, is the value for the
 variable `str' within the skeleton.  When this is non-nil, the
 interactor gets ignored, and this should be a valid skeleton element.
 
+When done with skeleton, but before going back to `_'-point, add
+a newline (unless `skeleton-end-newline' is non-nil) and run the
+hook `skeleton-end-hook'.
+
 SKELETON is made up as (INTERACTOR ELEMENT ...).  INTERACTOR may be nil if
 not needed, a prompt-string or an expression for complex read functions.
 
@@ -235,10 +238,7 @@ available:
                then: insert previously read string once more
        help    help-form during interaction with the user or nil
        input   initial input (string or cons with index) while reading str
-       v1, v2  local variables for memorizing anything you want
-
-When done with skeleton, but before going back to `_'-point call
-`skeleton-end-hook' if that is non-nil."
+       v1, v2  local variables for memorizing anything you want"
   (let ((skeleton-regions regions))
     (and skeleton-regions
         (setq skeleton-regions