diff options
author | 2012-10-29 20:45:58 -0400 | |
---|---|---|
committer | 2012-10-29 20:45:58 -0400 | |
commit | fa38d2306fadc99bb1403433517ecf45a24062eb (patch) | |
tree | 19f286adb6be4cbd7a1b11fc1c880976a01ea9fd /modules/textadept/snippets.lua | |
parent | 6718de08a3f19f8c24c1c4167b05828a7ac0dfd7 (diff) | |
download | textadept-fa38d2306fadc99bb1403433517ecf45a24062eb.tar.gz textadept-fa38d2306fadc99bb1403433517ecf45a24062eb.zip |
Updated documentation formatting.
Pathnames and filenames are italic and be more consistent with constant width
text.
Diffstat (limited to 'modules/textadept/snippets.lua')
-rw-r--r-- | modules/textadept/snippets.lua | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/modules/textadept/snippets.lua b/modules/textadept/snippets.lua index 6dd9fdb2..c179a580 100644 --- a/modules/textadept/snippets.lua +++ b/modules/textadept/snippets.lua @@ -10,7 +10,7 @@ local M = {} -- -- Snippets are defined in the global table `snippets`. Each key-value pair in -- `snippets` consists of either a string trigger word and its snippet text, or --- a string lexer language (from the `lexers/` directory) with a table of +-- a string lexer language (from the *lexers/* directory) with a table of -- trigger words and snippet texts. When searching for a snippet to insert based -- on a trigger word, snippets in the current lexer have priority, followed by -- the ones in the global table. This means if there are two snippets with the @@ -19,9 +19,9 @@ local M = {} -- -- ## Snippet Syntax -- --- Any plain text characters may be used with the exception of `%`. Just like in --- Lua patterns, `%` is an escape character. The sequence `%%` stands for a --- single `%`. Also, it is recommended to use `\t` characters for indentation +-- Any plain text characters may be used with the exception of '%'. Just like in +-- Lua patterns, '%' is an escape character. The sequence "%%" stands for a +-- single '%'. Also, it is recommended to use "\t" characters for indentation -- because they can be converted to spaces based on the current indentation -- settings. In addition to plain text, snippets can contain placeholders for -- further user input, can mirror or transform those user inputs, and/or execute @@ -360,7 +360,7 @@ M._snippet_mt = { snippet_stack[#snippet_stack] = nil end, - -- Finishes a snippet by going to its `%0` placeholder and cleaning up. + -- Finishes a snippet by going to its "%0" placeholder and cleaning up. -- @param snippet The snippet returned by `new_snippet()`. finish = function(snippet) local buffer = buffer |