Skip to content

Commit 073e1dd

Browse files
docs(vimdoc): Auto-generate user / API documentation + vimtags
1 parent d408090 commit 073e1dd

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

doc/lua-console.nvim.txt

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ development and Neovim exploration and configuration. Acts as a user friendly
2222
replacement of command mode - messages loop and as a handy scratch pad to store
2323
and test your code gists.
2424

25-
**Update: Although it originated as a tool for Lua development, it has now
25+
**Update: although it originated as a tool for Lua development, it has now
2626
evolved into supporting other languages too. See evaluating other languages.**
2727

2828

@@ -174,11 +174,11 @@ EVALUATING OTHER LANGUAGES ~
174174
SETTING UP
175175

176176
- It is possible to setup external code executors for other languages. Evaluators
177-
for `ruby` and `racket` are working out of the box, support for other languages
178-
is coming. Meanwhile, you can easily setup your own language.
179-
- Below is the default configuration which can be overridden or extended by your
180-
custom config (`default_process_opts` will be replaced by language specific
181-
opts), e.g. a possible config for `python` could be:
177+
for `ruby`,`racket` and `python` are working out of the box, support for other
178+
languages is coming. Meanwhile, you can easily setup your own language.
179+
- Below is the default configuration, which can be overridden or extended by your
180+
custom config, where `default_process_opts` will be replaced by language
181+
specific opts, e.g. a possible config for `python` could be:
182182
>lua
183183
require('lua-console').setup {
184184
external_evaluators = {
@@ -191,8 +191,6 @@ SETTING UP
191191
}
192192
}
193193
<
194-
- You can also setup a custom formatter to format the evaluator output before
195-
appending results to the console or buffer. Example is in the config.
196194
Default External Evaluators Settings
197195
~
198196
`exev_config.lua`
@@ -241,16 +239,16 @@ SETTING UP
241239

242240
return external_evaluators
243241
<
242+
- You can also setup a custom formatter to format the evaluator output before
243+
appending results to the console or buffer. Example is in the config.
244244
USAGE
245245
- The language evaluator is determined either from (in order of precedence):
246-
- The code prefix `===lang` on the line above your code snippet, in which case it only applies to the snippet directly below and it should be included in the selection
247-
for evaluation. The prefix can be changed in the config.
246+
- The code prefix `===lang` on the line above your code snippet, in which case it only applies to the snippet directly below. The prefix can be changed in the config.
248247
- The code prefix on the top line of the console/buffer, in which case it applies to the whole buffer.
249248
- The file type of the buffer.
250249
>racket
251250
===racket
252251

253-
254252
(define (log str)
255253
(displayln (format "~v" str)))
256254

@@ -266,6 +264,15 @@ SETTING UP
266264
===ruby
267265
5.times { puts 'Hey' }
268266
<
267+
- Code inside Lua comments will be sytax highlighted.
268+
>python
269+
[[===python
270+
list = [1, 3, 5, 7, 9]
271+
272+
for val in a:
273+
print(list)
274+
]]
275+
<
269276

270277

271278
ALTERNATIVES AND COMPARISON*lua-console.nvim-💻-lua-console-main-develop-luarocks-alternatives-and-comparison*

doc/lua-console.nvim_api.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ Return ~
104104
------------------------------------------------------------------------------
105105
*get_lang()*
106106

107-
`get_lang`({buf}, {lines})
107+
`get_lang`({buf}, {range})
108108

109109
the language of the code/console/buffer
110110

111111
lines array to remove the lang_prefix
112112
Parameters ~
113113
{buf} `(number)`
114-
{lines} `(string[])`
114+
{range} `(number[])`
115115

116116
Return ~
117117
`(string)`

0 commit comments

Comments
 (0)