From 88cdf14b37a7344bb266e94512485e3cc738c23d Mon Sep 17 00:00:00 2001 From: Noam Postavsky Date: Mon, 19 Dec 2016 19:49:47 -0500 Subject: [PATCH] Improve skeleton docstrings * 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 | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lisp/skeleton.el b/lisp/skeleton.el index 0e81e2d74c6..1b77a095fbc 100644 --- a/lisp/skeleton.el +++ b/lisp/skeleton.el @@ -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 -- 2.39.5