Skip to content

Commit 46d4b07

Browse files
Ote-LeoL3MON4D3
authored andcommitted
Minor DOC.md modifications for panvimdoc lists
Pandoc fails to parse markdown lists unless they come after an empty line. Thus the panvimdoc generated lists are crammed in a single paragraph.
1 parent 57c9f5c commit 46d4b07

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

DOC.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ When expanding a new snippet, it becomes a child of the snippet whose region it
130130
is expanded inside, and a root if it is not inside any snippet's region.
131131
If it is inside another snippet, the specific node it is inside is determined,
132132
and the snippet then nested inside that node.
133+
133134
* If that node is interactive (for example, an `insertNode`), the new snippet
134135
will be traversed when the node is visited, as long as the
135136
configuration-option `link_children` is enabled. If it is not enabled, it is
@@ -161,6 +162,7 @@ some nodes (`user_args` for function/dynamicNode). These `opts` are
161162
only mentioned if they accept options that are not common to all nodes.
162163

163164
Common opts:
165+
164166
* `node_ext_opts` and `merge_node_ext_opts`: Control `ext_opts` (most likely
165167
highlighting) of the node. Described in detail in [ext_opts](#ext_opts)
166168
* `key`: The node can be reffered to by this key. Useful for either [Key
@@ -691,6 +693,7 @@ API.
691693
For example, argnodes in functionNode, dynamicNode or lambda are
692694
node references.
693695
These references can be either of:
696+
694697
- `number`: the jump-index of the node.
695698
This will be resolved relative to the parent of the node this is passed to.
696699
(So, only nodes with the same parent can be referenced. This is very easy to
@@ -1206,9 +1209,11 @@ snippetNode, so even if the restoreNode only contains one node, that node has
12061209
to be accessed as `ai[restoreNodeIndx][0][1]`.
12071210

12081211
`absolute_indexer`s' can be constructed in different ways:
1212+
12091213
* `ai[1][2][3]`
12101214
* `ai(1, 2, 3)`
12111215
* `ai{1, 2, 3}`
1216+
12121217
are all the same node.
12131218

12141219
# MultiSnippet
@@ -1554,9 +1559,11 @@ a snippet's `condition` or `show_condition`. These are grouped accordingly into
15541559
`luasnip.extras.conditions.expand` and `luasnip.extras.conditions.show`:
15551560

15561561
**`expand`**:
1562+
15571563
- `line_begin`: only expand if the cursor is at the beginning of the line.
15581564

15591565
**`show`**:
1566+
15601567
- `line_end`: only expand at the end of the line.
15611568
- `has_selected_text`: only expand if there's selected text stored after pressing
15621569
`store_selection_keys`.
@@ -1820,6 +1827,7 @@ While this functionality can also be implemented by a cusutom
18201827
`resolveExpandParams`, this helper simplifies the common cases.
18211828

18221829
This matching of treesitter-nodes can be done either
1830+
18231831
* by providing a query and the name of the capture that should be in front of
18241832
the trigger (in most cases, the complete match, but requiring specific nodes
18251833
before/after the matched node may be useful as well), or
@@ -1943,6 +1951,7 @@ end
19431951
```
19441952

19451953
`snip.env` would contain:
1954+
19461955
* `LS_TSMATCH`: `{ "function add(a, b)", "\treturn a + b", "end" }`
19471956
* `LS_TSDATA`:
19481957
```lua
@@ -2018,6 +2027,7 @@ ts_post({
20182027
The module `luasnip.extras.treesitter_postfix` contains a few functions that may
20192028
be useful for creating more efficient ts-postfix-snippets.
20202029
Nested in `builtin.tsnode_matcher` are:
2030+
20212031
* `fun find_topmost_types(types: string[]): MatchTSNodeFunc`: Generates
20222032
a `LuaSnip.extra.MatchTSNodeFunc` which returns the last parent whose type
20232033
is in `types`.
@@ -2216,6 +2226,7 @@ This is primarily implemented for snippet which got their source from one of the
22162226
loaders, but might also work for snippets where the source was set manually.
22172227

22182228
`require("luasnip.extras.snip_location")`:
2229+
22192230
* `snip_location.jump_to_snippet(snip, opts)`
22202231
Jump to the definition of `snip`.
22212232
* `snip`: a snippet with attached source-data.
@@ -2344,6 +2355,7 @@ This behaviour can be modified by changing `parser_nested_assembler` in
23442355

23452356
LuaSnip will also modify some snippets that it is incapable of representing
23462357
accurately:
2358+
23472359
- if the `$0` is a placeholder with something other than just text inside
23482360
- if the `$0` is a choice
23492361
- if the `$0` is not an immediate child of the snippet (it could be inside a

0 commit comments

Comments
 (0)