ld/yasnippet
1
0
Fork 0
mirror of https://github.com/joaotavora/yasnippet.git synced 2025-10-13 05:03:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

more links to docstrings, don't repeat docstrings

Browse Source
This commit is contained in:
Noam Postavsky 2013-11-24 20:44:18 -05:00
parent 08a44b43dc
commit eaeb6ff7a9
1 changed files with 8 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
doc/snippet-expansion.org
View File

@ -72,10 +72,10 @@ However, you can change this behavior by customizing the
*** Insert at point
The command =M-x yas-insert-snippet= lets you insert snippets at point
/for you current major mode/. It prompts you for the snippet key first,
and then for a snippet template if more than one template exists for the
same key.
The command [[#yas-insert-snippet][=yas-insert-snippet=]] lets you insert snippets at point
/for your current major mode/. It prompts you for the snippet key
first, and then for a snippet template if more than one template
exists for the same key.
The list presented contains the snippets that can be inserted at point,
according to the condition system. If you want to see all applicable
@ -181,42 +181,7 @@ snippets is just boring. So has a buffer local variable
=(not (python-in-string/comment))= in =python-mode-hook=.
Then, what if you really want some particular snippet to expand even
inside a comment? This is also possible! But let's stop telling the
story and look at the rules:
- If [[sym:yas-buffer-local-condition][=yas-buffer-local-condition=]] evaluate to nil, no snippets will be
considered for expansion.
- If it evaluates to the a /cons cell/ where the =car= is the symbol
=require-snippet-condition= and the =cdr= is a symbol (let's call it
=requirement=), then:
- Snippets having no =# condition:= directive won't be considered;
- Snippets with conditions that evaluate to nil (or produce an
error) won't be considered;
- If the snippet has a condition that evaluates to non-nil (let's
call it =result=):
- If =requirement= is =t=, the snippet is ready to be expanded;
- If =requirement= is =eq= to =result=, the snippet is ready to
be expanded;
- Otherwise the snippet won't be considered.
- If it evaluates to the symbol =always=, all snippets are considered
for expansion, regardless of any conditions.
- If it evaluate to =t= or some other non-nil value:
- If the snippet has no condition, or has a condition that evaluate
to non-nil, it is ready to be expanded.
- Otherwise, it won't be considered.
In the mentioned scenario, set [[sym:yas-buffer-local-condition][=yas-buffer-local-condition=]] like this
inside a comment? Set [[sym:yas-buffer-local-condition][=yas-buffer-local-condition=]] like this
#+BEGIN_SRC emacs-lisp
(add-hook 'python-mode-hook
@ -232,6 +197,9 @@ in comment to be evaluated to the symbol =force-in-comment=. Then it can
be expanded as you expected, while other snippets like =if= still can't
expanded in comment.
For the full set of possible conditions, see the documentation for
[[sym:yas-buffer-local-condition][=yas-buffer-local-condition=]].
*** Multiples snippet with the same key
The rules outlined [[Eligible%20snippets][above]] can return more than