mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-23 01:12:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
dc8934482e72cdc885da69f7318eabc21a4e8757
neovim/runtime/doc
History
Justin M. Keyes dc8934482e feat(api): optional params after opts #40720 
Problem:
After 25439dad7e, `opts` is optional, but not params that follow it.

Solution:
- Update `gen_api_dispatch.lua`, docs, tests.
- Enhance the `nvim_get_api_info()` api-metadata to include a boolean
  flag indicating whether a parameter is optional:
  ```
  [type, name, optional]
  ```

Note: Currently, optional params are assumed to be Dict/Array. Since we
don't yet have any use-cases of optional params following `opts`, the
build just checks this assumption and we can deal with it later if we
ever care to:

    nvim_get_hl: optional param "foo" has type "Integer" but (currently)
    we assume Dict/Array
2026-07-13 13:43:49 -04:00
..
api-ui-events.txt
fix(cmdline): encode no prompt in cmdline_show.hl_id
2026-06-22 15:56:26 +02:00
api.txt
feat(api): optional params after opts #40720
2026-07-13 13:43:49 -04:00
autocmd.txt
feat(channel): add ChanClose event #40568
2026-07-04 15:21:25 -04:00
change.txt
vim-patch:1188cac: runtime(doc): Tweak documentation style and typo
2026-06-27 07:04:55 +08:00
channel.txt
feat(prompt): support 'scrollback' option in prompt-buffers #39793
2026-05-16 10:14:18 -04:00
cmdline.txt
fix(cmdwin): handle split/tabpage
2026-06-29 23:22:52 +02:00
credits.txt
vim-patch:9.1.1933: completion: complete_match() is not useful (#36726)
2025-11-28 10:10:31 +08:00
deprecated.txt
feat(api): add nvim_win_resize()
2026-07-05 21:47:34 +08:00
dev_arch.txt
refactor(insert): rename edit.c => insert.c #40705
2026-07-12 11:57:17 -04:00
dev_style.txt
docs: lsp, options, promptbuf
2026-02-12 13:46:45 +01:00
dev_test.txt
test: run Lua harness with nvim -l
2026-05-13 13:14:07 +01:00
dev_theme.txt
docs: news
2024-05-15 23:19:26 +02:00
dev_tools.txt
refactor(insert): rename edit.c => insert.c #40705
2026-07-12 11:57:17 -04:00
dev_vimpatch.txt
docs: misc #39511
2026-04-29 17:37:47 -04:00
dev.txt
refactor: cleanup, docs #40480
2026-06-29 13:10:31 -04:00
diagnostic.txt
feat(diagnostic): debounce current-line render #39542
2026-06-15 11:11:57 -04:00
diff.txt
docs: rename "tabpage"
2026-05-07 10:36:55 +02:00
digraph.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
editing.txt
feat(restart)!: ZR restores session #40498
2026-07-09 07:09:12 -04:00
faq.txt
fix(ux): drop "Sorry" from messages #38318
2026-03-16 07:46:34 -04:00
filetype.txt
vim-patch:dd89754: runtime(typst): Improve ftplugin, and syntax file
2026-07-02 08:14:48 +08:00
fold.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
ft_ada.txt
docs: misc
2025-12-06 20:33:02 -05:00
ft_hare.txt
docs: treesitter parse errors #33811
2025-05-03 10:08:53 -07:00
ft_ps1.txt
docs: treesitter parse errors #33811
2025-05-03 10:08:53 -07:00
ft_raku.txt
fix(docs): vimdoc syntax errors
2023-06-25 17:14:28 +02:00
ft_rust.txt
vim-patch:880cf88: runtime(doc): Various fixes for ft_rust.txt (tw78, grammar, spaces) (#38730)
2026-04-03 21:38:44 +08:00
ft_sql.txt
docs: drop "xx.vim" syntax help-tags #35623
2025-09-07 20:45:22 -07:00
gui.txt
fix(:restart): remove -S [file] from v:argv #40521
2026-07-05 17:53:45 -04:00
health.txt
refactor(docs): generate tui.txt $NVIM_TERMDEFS keys #39836
2026-05-21 04:39:45 -04:00
help.txt
docs: misc #39045
2026-04-18 15:38:59 -04:00
helphelp.txt
feat(help): super K (":help!") guesses tag at cursor #36205
2026-03-15 19:02:49 -04:00
if_perl.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
if_pyth.txt
vim-patch:faad250: runtime(doc): Fix typo in if_pyth.txt (#38362)
2026-03-19 11:10:54 +08:00
if_ruby.txt
docs: misc #37357
2026-01-27 17:14:57 -05:00
indent.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
index.txt
refactor: cleanup, docs #40480
2026-06-29 13:10:31 -04:00
insert.txt
vim-patch:9.2.0624: C-N/C-P cannot be mapped in complete() completion (#40232)
2026-06-14 05:15:07 +00:00
intro.txt
docs: remove ICCF Holland URL (#37230)
2026-01-09 16:38:26 +08:00
job_control.txt
test: lint EXX error codes #8155
2026-04-16 10:48:11 -04:00
l10n-arabic.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
l10n-hebrew.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
l10n-russian.txt
vim-patch:17bba75: runtime(doc): Fix overlength lines in :help {russian,vietnamese}.txt
2026-01-26 07:05:42 +08:00
l10n-vietnamese.txt
vim-patch:17bba75: runtime(doc): Fix overlength lines in :help {russian,vietnamese}.txt
2026-01-26 07:05:42 +08:00
lsp.txt
feat(api): optional params after opts #40720
2026-07-13 13:43:49 -04:00
lua-bit.txt
docs: change lua-bit to new layout #38447
2026-03-23 17:41:48 -04:00
lua-guide.txt
docs: bufadd(), fnameescape() guidance #40378
2026-06-23 10:08:50 -04:00
lua-plugin.txt
docs: bufadd(), fnameescape() guidance #40378
2026-06-23 10:08:50 -04:00
lua.txt
feat(api): optional params after opts #40720
2026-07-13 13:43:49 -04:00
luaref.txt
feat(docs): numbered listitems
2025-12-15 13:55:15 -05:00
luvref.txt
build(deps): bump luv to 1.52.1-0
2026-03-16 10:29:58 +01:00
map.txt
vim-patch:ecba601: runtime(doc): fix a few small problems (#39969)
2026-05-24 00:10:36 +00:00
mbyte.txt
vim-patch:8.2.2440: documentation based on patches is outdated (#39144)
2026-04-17 09:50:03 +08:00
message.txt
test: lint EXX error codes #8155
2026-04-16 10:48:11 -04:00
mlang.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
motion.txt
vim-patch:9.2.0640: the "%" command jumps to parens and braces inside comments (#40229)
2026-06-14 10:52:50 +08:00
news-0.9.txt
docs: json, tests, lsp #35754
2025-09-28 20:57:59 -07:00
news-0.10.txt
fix(lsp): deprecate vim.lsp.protocol.Methods (#35998)
2025-10-04 21:09:13 -07:00
news-0.11.txt
docs: rename "tabpage"
2026-05-07 10:36:55 +02:00
news-0.12.txt
docs: misc, rename "tabpage"
2026-05-07 10:36:48 +02:00
news.txt
feat(api): optional params after opts #40720
2026-07-13 13:43:49 -04:00
nvim.txt
docs: dev, lsp, indent-guides #39756
2026-05-14 13:13:30 -04:00
options.txt
fix(path): normalize separators (slashes) #39155
2026-07-12 13:23:44 -04:00
pack.txt
feat(pack): 'packlockfile' option #40562
2026-07-08 12:23:28 -04:00
pattern.txt
fix(lua): vim.wait(0) does not call loop_poll #39679
2026-05-10 14:22:31 -04:00
pi_gzip.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
pi_msgpack.txt
feat(docs): numbered listitems
2025-12-15 13:55:15 -05:00
pi_paren.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
pi_spec.txt
docs: fix treesitter parsing errors
2023-01-01 15:05:13 +01:00
pi_tar.txt
vim-patch:e6a84bb: runtime(tar): missing g:tar_secure in tar#Extract() (#39123)
2026-04-16 22:19:48 +08:00
pi_tutor.txt
vim-patch:5a8f995: runtime(doc): remove outdated Contribution section in pi_tutor (#34094)
2025-05-20 00:21:30 +00:00
pi_zip.txt
vim-patch:9.2.0678: [security]: potential powershell code execution in zip.vim (#40343)
2026-06-21 08:12:27 +08:00
plugins.txt
docs(dir): remove augroup deletion note #40696
2026-07-11 18:20:27 -04:00
provider.txt
docs: setting g:clipboard after provider init #37705
2026-02-04 13:53:08 -05:00
quickfix.txt
vim-patch:9.2.0547: "%v" in 'errorformat' is affected by 'tabstop' (#40040)
2026-05-29 09:35:37 +08:00
quickref.txt
feat(normal): lines textobject "il", "al" #39845
2026-05-19 05:08:23 -04:00
recover.txt
vim-patch:9.2.0486: out-of-bound read when recovering swap files (#39807)
2026-05-16 08:07:22 +08:00
remote_plugin.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
remote.txt
docs: misc, custom text-object #39877
2026-05-20 05:21:27 -04:00
repeat.txt
docs: starting.txt new layout
2026-03-22 01:57:28 +01:00
rileft.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
scroll.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
sign.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
spell.txt
vim-patch:9.2.0524: spell: buffer overflow with many affix or compound flags
2026-05-24 18:02:03 +08:00
starting.txt
feat(:restart): v:startreason #40186
2026-06-18 15:49:12 -04:00
support.txt
ci: drop cirrus #39321
2026-04-22 18:25:07 -04:00
syntax.txt
vim-patch:77099ed: runtime(cpp): add C++26 lexical constructs to syntax highlighting
2026-06-22 09:51:52 +08:00
tabpage.txt
docs: misc #39817
2026-05-17 10:02:12 -04:00
tagsrch.txt
vim-patch:partial:9.2.0573: Vim9: missing EX_WHOLE on some block keywords (#40071)
2026-06-01 01:04:30 +00:00
terminal.txt
feat(terminal): try to find newer conpty.dll on Windows #40328
2026-06-29 14:46:23 -04:00
tips.txt
vim-patch:5427465: runtime(doc): Clean up file header whitespace
2025-11-10 11:13:56 +08:00
treesitter.txt
fix(docs): numbered listitems
2026-06-11 13:35:19 +02:00
tui.txt
refactor(docs): generate tui.txt $NVIM_TERMDEFS keys #39836
2026-05-21 04:39:45 -04:00
uganda.txt
vim-patch:19a5020: runtime(doc): Fix paypal link
2026-06-08 11:43:52 +08:00
undo.txt
docs: api, plugins, ui2
2026-03-24 00:14:55 +01:00
userfunc.txt
vim-patch:8.2.2440: documentation based on patches is outdated (#39144)
2026-04-17 09:50:03 +08:00
usr_01.txt
docs: misc, rename "tabpage"
2026-05-07 10:36:48 +02:00
usr_02.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_03.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_04.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_05.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_06.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_07.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_08.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_09.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_10.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_11.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_12.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_20.txt
vim-patch:partial:9.2.0573: Vim9: missing EX_WHOLE on some block keywords (#40071)
2026-06-01 01:04:30 +00:00
usr_21.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_22.txt
feat(dir.lua): global "-" default mapping #40426
2026-06-26 06:17:00 -04:00
usr_23.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_24.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_25.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_26.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_27.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_28.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_29.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_30.txt
vim-patch:ecba601: runtime(doc): fix a few small problems (#39969)
2026-05-24 00:10:36 +00:00
usr_31.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_32.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_40.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_41.txt
vim-patch:e99b4d0: runtime(doc): Document ft_recommended_style
2026-06-29 08:47:54 +08:00
usr_42.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_43.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_44.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_45.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
usr_toc.txt
docs: adjust modelines for HTML rendering #39649
2026-05-07 08:32:27 -04:00
various.txt
vim-patch:44a1a6a: runtime(doc): Update wrong shellescape() example
2026-05-22 07:40:03 +08:00
vi_diff.txt
docs: misc, rename "tabpage"
2026-05-07 10:36:48 +02:00
vim_diff.txt
fix(dir): define "-" (up/parent) mapping earlier #40531
2026-07-02 15:55:48 -04:00
vimeval.txt
refactor: cleanup, docs #40480
2026-06-29 13:10:31 -04:00
vimfn.txt
fix(path): normalize separators (slashes) #39155
2026-07-12 13:23:44 -04:00
visual.txt
vim-patch:c7645fc: runtime(doc): add a few references to mouse behaviour (#39959)
2026-05-23 07:47:49 +08:00
vvars.txt
refactor: cleanup, docs #40480
2026-06-29 13:10:31 -04:00
windows.txt
fix(api): nvim_win_resize tweaks #40596
2026-07-05 13:22:16 -04:00