Fix outdated and misformatted docs

yas-find-snippets was removed by [1].

* doc/snippet-development.org: Add keybindings on same line as command
names, fixup intra document links, and remove mention of non-existent
command yas-find-snippets.
* yasnippet.el (yas-load-snippet-buffer):
(yas-load-snippet-buffer-and-close): Fix docstring formatting.

[1]: "cleanup: remove `yas/find-snippets\', complicated and no one seems
to use it anyway" 29 May, 2012 433c93746534ebb062afe4dbc7690f736be72d42.
This commit is contained in:
Noam Postavsky 2016-05-10 12:21:14 -04:00
parent e9406f5126
commit 6f97316551
2 changed files with 31 additions and 38 deletions

View File

@ -8,52 +8,48 @@
There are some ways you can quickly find a snippet file or create a new one: There are some ways you can quickly find a snippet file or create a new one:
- =M-x yas-new-snippet= - =M-x yas-new-snippet=, key bindind: =C-c & C-n=
Creates a new buffer with a template for making a new snippet. Creates a new buffer with a template for making a new snippet. The
The buffer is in =snippet-mode= (see below). When you are done buffer is in =snippet-mode= (see [[snippet-mode][below]]). When you are done editing
editing the new snippet, use =C-c C-c= to save it. This will the new snippet, use [[yas-load-snippet-buffer-and-close][=C-c C-c=]] to save it.
prompt for a directory two steps: first, the snippet table
(with a default based on the major mode you started in), and then
then snippet collection directory (defaults to the first directory
in =yas-snippet-dirs=. (See [[file:snippet-organization.org][Organizing Snippets]]
for more detail on how snippets are organized.)
- =M-x yas-find-snippets= - =M-x yas-visit-snippet-file=, key binding: =C-c & C-v=
Lets you find the snippet file in the directory the snippet was
loaded from (if it exists) like =find-file-other-window=. The
directory searching logic is similar to =M-x yas-new-snippet=.
- =M-x yas-visit-snippet-file=
Prompts you for possible snippet expansions like Prompts you for possible snippet expansions like
[[sym:yas-insert-snippet][=yas-insert-snippet=]], but instead of expanding it, takes you directly [[sym:yas-insert-snippet][=yas-insert-snippet=]], but instead of expanding it, takes you directly
to the snippet definition's file, if it exists. to the snippet definition's file, if it exists.
Once you find this file it will be set to =snippet-mode= (see ahead) and Once you find this file it will be set to =snippet-mode= (see [[snippet-mode][ahead]])
you can start editing your snippet. and you can start editing your snippet.
** Using the =snippet-mode= major mode ** Using the =snippet-mode= major mode <<snippet-mode>>
There is a major mode =snippet-mode= to edit snippets. You can set the There is a major mode =snippet-mode= to edit snippets. You can set the
buffer to this mode with =M-x snippet-mode=. It provides reasonably buffer to this mode with =M-x snippet-mode=. It provides reasonably
useful syntax highlighting. useful syntax highlighting.
Two commands are defined in this mode: Three commands are defined in this mode:
- =M-x yas-load-snippet-buffer= - =M-x yas-load-snippet-buffer=, key binding: =C-c C-l=
When editing a snippet, this loads the snippet into the correct Prompts for a snippet table (with a default based on snippet's
mode and menu. Bound to =C-c C-c= by default while in major mode) and loads the snippet currently being edited.
=snippet-mode=.
- =M-x yas-tryout-snippet= - =M-x yas-load-snippet-buffer-and-close=, key binding: =C-c C-c=
<<yas-load-snippet-buffer-and-close>>
Like =yas-load-snippet-buffer=, but also saves the snippet and
calls =quit-window=. The destination is decided based on the
chosen snippet table and snippet collection directly (defaulting to
the first directory in =yas-snippet-dirs= (see [[file:snippet-organization.org][Organizing Snippets]]
for more detail on how snippets are organized).
- =M-x yas-tryout-snippet=, key binding: =C-c C-t=
When editing a snippet, this opens a new empty buffer, sets it to When editing a snippet, this opens a new empty buffer, sets it to
the appropriate major mode and inserts the snippet there, so you the appropriate major mode and inserts the snippet there, so you
can see what it looks like. This is bound to =C-c C-t= while in can see what it looks like.
=snippet-mode=.
There are also /snippets for writing snippets/: =vars=, =$f= and =$m= There are also /snippets for writing snippets/: =vars=, =$f= and =$m=
:-). :-).

View File

@ -2542,10 +2542,8 @@ neither do the elements of PARENTS."
(defun yas-load-snippet-buffer (table &optional interactive) (defun yas-load-snippet-buffer (table &optional interactive)
"Parse and load current buffer's snippet definition into TABLE. "Parse and load current buffer's snippet definition into TABLE.
TABLE is a symbol name passed to `yas--table-get-create'. When
TABLE is a symbol naming a passed to `yas--table-get-create'. called interactively, prompt for the table name."
When called interactively, prompt for the table name."
(interactive (list (yas--read-table) t)) (interactive (list (yas--read-table) t))
(cond (cond
;; We have `yas--editing-template', this buffer's content comes from a ;; We have `yas--editing-template', this buffer's content comes from a
@ -2570,11 +2568,10 @@ When called interactively, prompt for the table name."
(yas--table-name (yas--template-table yas--editing-template))))) (yas--table-name (yas--template-table yas--editing-template)))))
(defun yas-load-snippet-buffer-and-close (table &optional kill) (defun yas-load-snippet-buffer-and-close (table &optional kill)
"Load the snippet with `yas-load-snippet-buffer', possibly "Load and save the snippet, then `quit-window' if saved.
save, then `quit-window' if saved. Loading is performed by `yas-load-snippet-buffer'. If the
snippet is new, ask the user whether (and where) to save it. If
If the snippet is new, ask the user whether (and where) to save the snippet already has a file, just save it.
it. If the snippet already has a file, just save it.
The prefix argument KILL is passed to `quit-window'. The prefix argument KILL is passed to `quit-window'.