procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve skeleton docstrings

Browse source 
* 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.
This commit is contained in:
Noam Postavsky 2016-12-19 19:49:47 -05:00
parent ce5538248e
commit 88cdf14b37
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lisp/skeleton.el
View file

@ -59,8 +59,7 @@ region.")
(make-obsolete-variable 'skeleton-autowrap nil "24.5") (make-obsolete-variable 'skeleton-autowrap nil "24.5")
(defvar skeleton-end-newline t (defvar skeleton-end-newline t
"If non-nil, make sure that the skeleton inserted ends with a newline. "If non-nil, make sure that the skeleton inserted ends with a newline.")
This just influences the way the default `skeleton-end-hook' behaves.")
(defvar skeleton-end-hook nil (defvar skeleton-end-hook nil
"Hook called at end of skeleton but before going to point of interest. "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 variable `str' within the skeleton. When this is non-nil, the
interactor gets ignored, and this should be a valid skeleton element. 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 SKELETON is made up as (INTERACTOR ELEMENT ...). INTERACTOR may be nil if
not needed, a prompt-string or an expression for complex read functions. not needed, a prompt-string or an expression for complex read functions.
@ -235,10 +238,7 @@ available:
then: insert previously read string once more then: insert previously read string once more
help help-form during interaction with the user or nil help help-form during interaction with the user or nil
input initial input (string or cons with index) while reading str input initial input (string or cons with index) while reading str
v1, v2 local variables for memorizing anything you want 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."
(let ((skeleton-regions regions)) (let ((skeleton-regions regions))
(and skeleton-regions (and skeleton-regions
(setq skeleton-regions (setq skeleton-regions