doc: improve section on fmt. by L3MON4D3 · Pull Request #551 · L3MON4D3/LuaSnip

L3MON4D3 · 2022-08-26T10:25:05Z

No description provided.

L3MON4D3 · 2022-08-29T09:55:09Z

Thank you for already taking a look @leiserfg :)
I think I'll throw the other changes ("jump index" everywhere) mentioned in #550 in here too.

leiserfg · 2022-08-29T10:35:07Z

Maybe add a Notes section and there explain it and link it in the entries referring to it? So you don't have to put the same in several places?

L3MON4D3 · 2022-08-29T11:16:27Z

Do you mean for explaining jump-index? Right, that's actually missing 😅
But I don't really get what's duplicated right now

leiserfg · 2022-08-29T11:23:25Z

It is not, just if you will document the behaviour in other places you could just link it.

L3MON4D3 · 2022-08-29T11:28:38Z

Makes sense 👍
I've though of doing something like that for the argnodes passed to function/dynamicNode, since they can be

just an integer for the jump-index
absolute_indexer
or even just a node
(or, I guess just refer to them by a proper name as well.. maybe "node-reference")

L3MON4D3 · 2022-08-29T11:31:43Z

Though that is a pretty big number of links.. But you're right, it will come in handy.
Maybe a glossary, preferably at the end?

DOC.md

L3MON4D3 · 2022-08-31T23:00:39Z

I've opted for working the sections that explain those concepts into the text, feels more natural than a big glossary at the end IMO, but happy to hear reasons for doing it differently :D

danielo515 · 2022-09-01T16:53:46Z

That sounds awesome!

L3MON4D3 · 2022-10-07T19:26:48Z

Okay I think this is done, I'll hold off from merging until #612 is in, don't wanna complicate that.

I've though about turning list-entries in API-REFERENCE to subsections (+: can link directly to those, -: it's pretty unnecessary for short stuff, which is most of these), but don't think it's worth it

Previously, jump-index, position, jump-position were used interchangibly. Explain concept of node-references ([number/absolute_indexer/node] passed to function/dynamicNodes). Also, give more detailed reference for especially the node-constructors.

L3MON4D3 · 2022-10-09T22:32:17Z

Oookay, gonna have one last look tomorrow when I don't have past-midnight-brain, then merge

bew · 2022-10-10T14:41:41Z

doc/luasnip.txt

-parent (`parent.snippet`), which is passed to the function.
+SNIPPET-DATA ~
+
+Snippets contain some interesting tables during runtime: - `snippet.env`:


don't you want to make a list here? having all items of the list on the same line isn't specially readable :/

bew · 2022-10-10T14:42:16Z

doc/luasnip.txt

 <


+`t(text, node_opts)`: - `text`: `string` or `string[]` - `node_opts`: `table`,


bew · 2022-10-10T14:43:10Z

doc/luasnip.txt

-
-
-Examples: Use captures from the regex-trigger using a functionNode:
+`f(fn, argnode_references, node_opts)`: - `fn`: `function(argnode_text, parent,


here as well

bew · 2022-10-10T14:44:15Z

doc/luasnip.txt

+
+Node-references are used to refer to other nodes in various parts of
+luasnip’s API. For example, argnodes in functionNode, dynamicNode or lambda
+are node-references. These references can be either of: - `number`: the


here also? for these references can be either of ....

bew · 2022-10-10T14:45:02Z

doc/luasnip.txt

-    that to construct `choiceNode`s:
-    `lua     local function restore_cursor_choice(pos, choices, opts)         if opts then             opts.restore_cursor = true         else             opts = {restore_cursor = true}         end         return c(pos, choices, opts)     end`
-
+`c(jump_index, choices, node_opts)` - |luasnip-`jump_index`|: `number`, since


here (I think searching for a dash surrounded by spaces can find you all inlined lists)

bew · 2022-10-10T14:46:13Z

doc/luasnip.txt

+`match` can insert text based on a predicate (again, a shorthand for
+`functionNode`).
+
+`match(argnodes, condition, then, else)`, where * `argnode`: A single


another list, using * instead of -

L3MON4D3 · 2022-10-10T15:05:58Z

Mhmm, looks like the helptext-generator is messing those up.
Check DOC.md, there they actually are lists

L3MON4D3 · 2022-10-10T15:28:48Z

pushed a fix, 4b8d678

L3MON4D3 · 2022-10-10T15:33:02Z

Thank you for bringing them to my attention, I very rarely check the help-files 😅

bew · 2022-10-10T15:46:02Z

Much better 👍

L3MON4D3 mentioned this pull request Aug 26, 2022

rep node seems to reset the count #550

Closed

leiserfg approved these changes Aug 28, 2022

View reviewed changes

L3MON4D3 force-pushed the fmt_doc_improve branch from 6ab1067 to 4fb2af7 Compare August 29, 2022 10:26

danielo515 reviewed Aug 29, 2022

View reviewed changes

DOC.md Outdated Show resolved Hide resolved

DOC.md Outdated Show resolved Hide resolved

DOC.md Outdated Show resolved Hide resolved

DOC.md Outdated Show resolved Hide resolved

L3MON4D3 force-pushed the fmt_doc_improve branch 5 times, most recently from de00ef2 to 5266dd6 Compare August 31, 2022 22:57

L3MON4D3 force-pushed the fmt_doc_improve branch from 4f844a9 to fe19556 Compare September 9, 2022 14:54

L3MON4D3 force-pushed the fmt_doc_improve branch from 55b5e59 to 4585e98 Compare September 23, 2022 10:39

L3MON4D3 force-pushed the fmt_doc_improve branch from 9d61c8b to 0f25785 Compare October 7, 2022 19:23

L3MON4D3 force-pushed the fmt_doc_improve branch 2 times, most recently from b9cdc1d to ebd3060 Compare October 9, 2022 21:51

L3MON4D3 force-pushed the fmt_doc_improve branch from 72d1ff8 to 67372c6 Compare October 9, 2022 22:25

Auto generate docs

b0d4044

L3MON4D3 merged commit 032c565 into master Oct 10, 2022

bew reviewed Oct 10, 2022

View reviewed changes

doc/luasnip.txt

<

`t(text, node_opts)`: - `text`: `string` or `string[]` - `node_opts`: `table`,

Copy link

Contributor

bew Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here

bew reviewed Oct 10, 2022

View reviewed changes

		<


		`t(text, node_opts)`: - `text`: `string` or `string[]` - `node_opts`: `table`,



		Examples: Use captures from the regex-trigger using a functionNode:
		`f(fn, argnode_references, node_opts)`: - `fn`: `function(argnode_text, parent,

Uh oh!

Conversation

L3MON4D3 commented Aug 26, 2022

Uh oh!

L3MON4D3 commented Aug 29, 2022

Uh oh!

leiserfg commented Aug 29, 2022

Uh oh!

L3MON4D3 commented Aug 29, 2022

Uh oh!

leiserfg commented Aug 29, 2022

Uh oh!

L3MON4D3 commented Aug 29, 2022

Uh oh!

L3MON4D3 commented Aug 29, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

L3MON4D3 commented Aug 31, 2022

Uh oh!

danielo515 commented Sep 1, 2022

Uh oh!

L3MON4D3 commented Oct 7, 2022

Uh oh!

L3MON4D3 commented Oct 9, 2022

Uh oh!

bew Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

bew Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

bew Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

bew Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

bew Oct 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bew Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

L3MON4D3 commented Oct 10, 2022

Uh oh!

L3MON4D3 commented Oct 10, 2022

Uh oh!

L3MON4D3 commented Oct 10, 2022

Uh oh!

bew commented Oct 10, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bew Oct 10, 2022 •

edited

Loading