aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/api.txt
Commit message (Collapse)AuthorAge
...
* feat(lua): add missing changes to autocmds lost in the rebaseTJ DeVries2022-02-28
| | | | Note: some of these changes are breaking, like change of API signatures
* feat(lua): add <f-args> to user commands callback (#17522)Javier Lopez2022-02-27
| | | | | Works similar to ex <f-args>. It only splits the arguments if the command has more than one posible argument. In cases were the command can only have 1 argument opts.fargs = { opts.args }
* feat(api): implement nvim_buf_get_text (#15181)Gregory Anders2022-02-22
| | | | | | | | | | nvim_buf_get_text is the mirror of nvim_buf_set_text. It differs from nvim_buf_get_lines in that it allows retrieving only portions of lines. While this can typically be done easily enough by API clients, implementing this function provides symmetry between the get/set text/lines APIs, and also provides a nice convenience that saves API clients the work of having to slice the result of nvim_buf_get_lines themselves.
* docs: minor changes related to mapping descriptionzeertzjq2022-02-16
|
* docs: regenerate [skip ci]marvim2022-02-13
|
* chore: fix typos (#17250)dundargoc2022-02-08
| | | | | | Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Dani Dickstein <daniel.dickstein@gmail.com> Co-authored-by: Axel Dahlberg <git@valleymnt.com>
* docs: regenerate [skip ci]marvim2022-01-17
|
* fix(api): force redefinition of user commands by default (#16918)Gregory Anders2022-01-04
|
* chore: fix typos (#16816)dundargoc2022-01-04
| | | | | | | Co-authored-by: Sean Dewar <seandewar@users.noreply.github.com> Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: Sebastian Volland <seb@baunz.net> Co-authored-by: Lewis Russell <lewis6991@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com>
* feat(api): add support for lua function & description in keymapshadmansaleh2022-01-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Behavioral changes: 1. Added support for lua function in keymaps in -------------------------------------------- - nvim_set_keymap Can set lua function as keymap rhs like following: ```lua vim.api.nvim_{buf_}set_keymap('n', '<leader>lr', '', {callback = vim.lsp.buf.references}) ``` Note: lua function can only be set from lua . If api function being called from viml or over rpc this option isn't available. - nvim_{buf_}get_keymap When called from lua, lua function is returned is `callback` key . But in other cases callback contains number of the function ref. - :umap, nvim_del_keymap & nvim_buf_del_keymap clears lua keymaps correctly. - :map commands for displaing rhs . For lua keymaps rhs is displayed as <Lua function ref_no> Note: lua keymap cannot be set through viml command / functions. - mapargs() When dict is false it returns string in `<Lua function ref_no>` format (same format as :map commands). When dict is true it returns ref_no number in `callback` key. - mapcheck() returns string in `<Lua function ref_no>` format (same format as :map commands). 2. Added support for keymap description --------------------------------------- - nvim_{buf_}set_keymap: added `desc` option in opts table . ```lua vim.api.nvim_set_keymap('n', '<leader>w', '<cmd>w<cr>', {desc='Save current file'}) ``` - nvim_{buf_}get_keymap: contains `desc` in returned list. - commands like `:nmap <leader>w` will show description in a new line below rhs. - `maparg()` return dict contains `desc`.
* Merge pull request #16752 from gpanders/lua-user-commandsBjörn Linse2021-12-28
|\ | | | | feat(api): implement nvim_{add,del}_user_command
| * feat(api): implement nvim_{add,del}_user_commandGregory Anders2021-12-28
| | | | | | | | | | Add support for adding and removing custom user commands with the Nvim API.
* | chore: fix typos (#16506)dundargoc2021-12-28
|/ | | | | | | | | Co-authored-by: Gregory Anders <8965202+gpanders@users.noreply.github.com> Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com> Co-authored-by: Christoph Hasse <hassec@users.noreply.github.com> Co-authored-by: Alef Pereira <ealefpereira@gmail.com> Co-authored-by: AusCyber <willp@outlook.com.au> Co-authored-by: kylo252 <59826753+kylo252@users.noreply.github.com>
* docs: regenerate (#16468)github-actions[bot]2021-12-15
| | | Co-authored-by: marvim <marvim@users.noreply.github.com>
* fix(api): allow nvim_buf_set_extmark to accept end_row key (#16548)Gregory Anders2021-12-08
| | | | | | | nvim_buf_get_extmark uses "end_row" rather than "end_line" in its 'details' dict, which means callers must modify the key names if they want to re-use the information. Change the parameter name in nvim_buf_set_extmark to "end_row" and use "end_line" as an alias to make this more consistent.
* docs: regenerate (#16390)github-actions[bot]2021-11-27
| | | Co-authored-by: marvim <marvim@users.noreply.github.com>
* docs: regeneratemarvim2021-11-18
|
* refactor(api/marks)!: add opts param for feature extensibility (#16146)Javier Lopez2021-11-01
| | | | | In the future we might want to extend the concept of named marks and adding opts reduces the need of changing the function signature in the furute.
* fix(gen_vimdoc.py): spacing around inline elements #16092Gregory Anders2021-10-19
| | | | | The spacing fix drew attention to a couple of places that were using incorrect formatting such as the key listing for `nvim_open_win`, so those were fixed too.
* docs: regenerate (#15986)github-actions[bot]2021-10-19
| | | Co-authored-by: marvim <marvim@users.noreply.github.com>
* docs: regenerate #15545github-actions[bot]2021-10-05
|
* feat(api): named marks set, get, delete #15346Javier Lopez2021-10-05
| | | | | | | | | | | | | | | | | | | | | | | Adds the following API functions. - nvim_buf_set_mark(buf, name, line, col) * Set marks in a buffer. - nvim_buf_del_mark(buf, name) * Delete a mark that belongs to buffer. - nvim_del_mark(name) * Delete a global mark. - nvim_get_mark(name) * Get a global mark. Tests: - Adds test to all the new api functions, and adds more for the existing nvim_buf_get_mark. * Tests include failure cases. Documentation: - Adds documentation for all the new functions, and improves the existing fucntion docs.
* docs: fix typoAditya Kurdunkar2021-10-04
|
* docs: extmarks indexing #15311Justin M. Keyes2021-09-10
| | | | ref #11456
* docs: extmarks indexing #15311Javier López2021-09-10
| | | | fix #11456
* docs: extmark indexing #12742Patrice Peterson2021-09-10
| | | | | | | Extmarks mostly use api-indexing, except for nvim_buf_get_extmarks(), which uses api-indexing with inclusive ranges. ref #11456
* refactor: remove remaining references to nvim_buf_set_virtual_textGregory Anders2021-08-03
|
* docs: regeneratemarvim2021-07-31
|
* docs: regeneratemarvim2021-07-26
|
* docs(tree-sitter): document highlight priorityStephan Seitz2021-07-22
|
* docs: regeneratemarvim2021-07-08
|
* fix(doc/api): Remove 'border' as unsupported (#14916)Daniel Steinberg2021-06-28
| | | PR #13998 added support for floating window borders.
* docs: regeneratemarvim2021-06-14
|
* docs: regeneratemarvim2021-06-10
|
* Merge pull request #14510 from urandom/doc_nvim_buf_set_extmarkBjörn Linse2021-06-10
|\ | | | | Minor observational corrections to the nvim_buf_set_extmark documentation
| * Update the functio documentation in CViktor Kojouharov2021-05-10
| |
| * Minor observational corrections to the set_extmark documentationViktor Kojouharov2021-05-07
| | | | | | | | | | Add a note for the line and col, saying they are 0-based. The end_col appears to be exclusive, unline the end_line.
* | docs: regeneratemarvim2021-06-02
| |
* | docs: regenerateKarim Abou Zeid2021-05-31
|/
* doc : fixing missing @return in nvim_open_term docMichael Bleuez2021-04-24
|
* docs: add priority option in buf_set_extmarkThomas Vigouroux2021-04-07
|
* Merge pull request #14091 from euclidianAce/euclidianAce/nvim_win_hideBjörn Linse2021-03-28
|\ | | | | api: add vim.api.nvim_win_hide
| * run docgenCorey Williamson2021-03-28
| |
* | api: destabilize nvim_set_hl_nsBjörn Linse2021-03-15
| | | | | | | | | | The sematics and signature of this API is going to change, but we don't wanna delay 0.5 for it. Mark API as unstable for now.
* | Update lsp, lua and api docs (gen_vimdoc.py)Mathias Fussenegger2021-03-11
|/
* Added If true to show that {after} and {follow} parameters of nvim_put() are ↵Lee Wannacott2021-03-07
| | | | expecting boolean values
* Forgot to add colon to the {follow} parameters statementLee Wannacott2021-03-07
|
* Clarify that nvim_put()'s {after} and {follow} parameters expect boolean ↵Lee Wannacott2021-03-07
| | | | values true, or false.
* Update lsp and api docs with gen_vimdoc changesMathias Fussenegger2021-02-24
| | | | | Applies the changes generated with ./scripts/gen_vimdoc.py to add missing documentation.
* Doc: update documentation for on_byteschentau2021-02-17
|