aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_vimdoc.py
Commit message (Collapse)AuthorAge
...
* fix: section_name must be a dict {filename:name}Matthieu Coudron2021-03-04
| | | | else it was triggering an error during regeneration of the files.
* docs: add check_textlock attributenotomo2020-12-16
|
* lsp: vim.lsp.diagnostic (#12655)TJ DeVries2020-11-12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Breaking Changes: - Deprecated all `vim.lsp.util.{*diagnostics*}()` functions. - Instead, all functions must be found in vim.lsp.diagnostic - For now, they issue a warning ONCE per neovim session. In a "little while" we will remove them completely. - `vim.lsp.callbacks` has moved to `vim.lsp.handlers`. - For a "little while" we will just redirect `vim.lsp.callbacks` to `vim.lsp.handlers`. However, we will remove this at some point, so it is recommended that you change all of your references to `callbacks` into `handlers`. - This also means that for functions like |vim.lsp.start_client()| and similar, keyword style arguments have moved from "callbacks" to "handlers". Once again, these are currently being forward, but will cease to be forwarded in a "little while". - Changed the highlight groups for LspDiagnostic highlight as they were inconsistently named. - For more information, see |lsp-highlight-diagnostics| - Changed the sign group names as well, to be consistent with |lsp-highlight-diagnostics| General Enhancements: - Rewrote much of the getting started help document for lsp. It also provides a much nicer configuration strategy, so as to not recommend globally overwriting builtin neovim mappings. LSP Enhancements: - Introduced the concept of |lsp-handlers| which will allow much better customization for users without having to copy & paste entire files / functions / etc. Diagnostic Enhancements: - "goto next diagnostic" |vim.lsp.diagnostic.goto_next()| - "goto prev diagnostic" |vim.lsp.diagnostic.goto_prev()| - For each of the gotos, auto open diagnostics is available as a configuration option - Configurable diagnostic handling: - See |vim.lsp.diagnostic.on_publish_diagnostics()| - Delay display until after insert mode - Configure signs - Configure virtual text - Configure underline - Set the location list with the buffers diagnostics. - See |vim.lsp.diagnostic.set_loclist()| - Better performance for getting counts and line diagnostics - They are now cached on save, to enhance lookups. - Particularly useful for checking in statusline, etc. - Actual testing :) - See ./test/functional/plugin/lsp/diagnostic_spec.lua - Added `guisp` for underline highlighting NOTE: "a little while" means enough time to feel like most plugins and plugin authors have had a chance to refactor their code to use the updated calls. Then we will remove them completely. There is no need to keep them, because we don't have any released version of neovim that exposes these APIs. I'm trying to be nice to people following HEAD :) Co-authored: [Twitch Chat 2020](https://twitch.tv/teej_dv)
* doc: Add docs for uri functions (#12887)TJ DeVries2020-09-14
|
* docs, remove 'guifontset' #11708Justin M. Keyes2020-08-31
| | | | | | | | | | | | | - remove redundant autocmd list This "grouped" list is useless, it only gets in the way when searching for event names. - intro.txt: cleanup - starting.txt: update, revisit - doc: `:help bisect` - mbyte.txt: update aliases 1656367b90bd. closes #11960 - options: remove 'guifontset'. Why: - It is complicated and is used by almost no one. - It is unlikely to be implemented by Nvim GUIs (complicated to parse, specific to Xorg...).
* gen_vimdoc: Allow to keep intermediary outputPatrice Peterson2020-08-23
|
* Add docs for most vim.lsp methodsPatrice Peterson2020-08-23
| | | | Most of the lsp.log will be addressed in a separate PR.
* script: simplify python version check (#12672)jnozsc2020-07-24
|
* doc: fix scripts and regenerate (#12506)TJ DeVries2020-07-02
| | | | | | | | | | | | | | | | | * Fix some small doc issues * doc: fixup * doc: fixup * Fix lint and rebase * Remove bad advice * Ugh, stupid mpack files... * Don't let people include these for now until they specifically want to * Prevent duplicate tag
* doc [ci skip] #11656Justin M. Keyes2020-01-12
|
* gen_vimdoc.py: rename `mode` to `target`Justin M. Keyes2019-12-31
|
* gen_vimdoc.py: generate LSP docsJustin M. Keyes2019-12-31
|
* gen_vimdoc.py: sort by nameJustin M. Keyes2019-12-30
|
* gen_vimdoc.py: better handling of inline (non-block) nodesJustin M. Keyes2019-12-30
|
* gen_vimdoc.py: fix deprecated checkJustin M. Keyes2019-12-30
|
* gen_vimdoc.py: lint #11593Daniel Hahler2019-12-23
|
* Merge #11396 'gen_vimdoc.py: mpack result' [ci skip]Justin M. Keyes2019-12-22
|\
| * gen_vimdoc.py: rename for clarityJustin M. Keyes2019-12-21
| | | | | | | | | | - render_para => fmt_node_as_vimhelp - Inline parse_parblock() in fmt_node_as_vimhelp()
| * gen_vimdoc.py: mpack: collect functions in 1 dictJustin M. Keyes2019-12-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | All Nvim API, core Vimscript, and core Lua functions are globally unique, so there is no need for per-module nested dicts. BEFORE (generated mpack structure): [ { "buffer.c": { "nvim__buf_stats": { ... }, ... }, "window.c": { "nvim_win_close": { ... }, ... }, ... } ] AFTER (generated mpack structure): [ { "nvim__buf_stats": { ... }, "nvim_buf_attach": { ... }, "nvim_tabpage_set_var": { ... }, "nvim_ui_attach": { ... }, "nvim_win_close": { ... } } ]
| * gen_vimdoc.py: fix "seealso", "xrefs"Justin M. Keyes2019-12-21
| | | | | | | | | | | | - Also fix xrefs ("Deprecated" section) - Fix "Deprecated" rendering by a weird hack (see comment). - Eliminate unnecessary use of render_para()
| * gen_vimdoc.py: mpack: exclude deprecated functionsJustin M. Keyes2019-12-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The `mpack` variable was a tuple, which manifests as an array in the generated msgpack structure. - Removes noise from the mpack data (deprecated functions are deprecated). - Eliminates 1 level of nesting. BEFORE: [ { "buffer.c": [ { "nvim__buf_stats": { ... }, ... }, { "buffer_del_line": { ... }, ... }, ], ... } ] AFTER: [ { "buffer.c": { "nvim__buf_stats": { ... }, ... }, ... ]
| * gen_vimdoc.py: fix mpack generatorJustin M. Keyes2019-12-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - make parameters_doc a dict intead of a list BEFORE: "parameters_doc": [ { "buffer": "Buffer handle, or 0 for current buffer" } ], AFTER: "parameters_doc": { "buffer": "Buffer handle, or 0 for current buffer" }, - make "return", "seealso", lists instead of strings
| * gen_vimdoc.py: DRYJustin M. Keyes2019-12-21
| |
| * [scripts/gen_vimdoc.py] Generate better-formatted mpacksmolck2019-11-15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changes the generated msgpack result values in the runtime/doc/*.mpack files to be formatted like this (instead of being formatted like Vim help text): [ 'nvim_win_get_var': { 'signature': 'nvim_win_get_var({window}, {name}, {err})', 'parameters': [('Window', 'window'), ('String', 'name'), ('Error *', 'err')], 'parameters_doc': [{'window': 'Window handle, or 0 for current window', 'name': 'Variable name'}], 'doc': ['Gets a window-scoped (w:) variable'], 'return': ['Variable value'], 'seealso': [] } }, ... ]
* | doc: Lua [ci skip] #11378Justin M. Keyes2019-11-17
|/ | | | - Rework :help lua-commands - Rename if_lua.txt => lua.txt
* lintJustin M. Keyes2019-10-26
|
* gen_vimdoc.py: dump API docs to msgpack #11296smolck2019-10-26
| | | | | | | | | | | | | | | | | | | | | | | Convenient for API clients who want to reuse the API docs in their own docs. Could be used e.g. to eliminate nvim.net's own doxygen parser: https://github.com/neovim/nvim.net/tree/3a736232a4e7b7a2a1eff4bded24d2bf27a918c2/src/NvimClient.APIGenerator/Docs TODO: currently the result values are formatted as Vim help docs. We should change the values to have structure, something like this: [{ 'nvim_win_get_var': [ 'line1, 'line2', [ 'item1', 'item2', ... ] ], 'nvim_win_set_var': [ ... ], ... }] close #11296
* doc: |api-fast| [ci skip]Justin M. Keyes2019-09-09
|
* py: flake8 fixesDaniel Hahler2019-07-29
|
* scripts: autopep8Daniel Hahler2019-07-29
|
* doc #10017Justin M. Keyes2019-05-25
| | | | | - gen_vimdoc.py: fancy "bullet" - rework `:help channel-callback` - rename `:help buffered` to `:help channel-buffered`
* gen_vimdoc.py: support lua/shared.lua module [ci skip]Justin M. Keyes2019-05-19
|
* gen_vimdoc.py: get Lua docs via lua2dox.lua #9740KillTheMule2019-05-18
|
* gen_vimdoc.py: support <pre> preformatted text [ci skip]Justin M. Keyes2019-05-01
|
* gen_vimdoc.py: skip "Parameters" header if all excludedJustin M. Keyes2019-04-22
|
* gen_vimdoc.py: render nested lists, etc [ci skip]Justin M. Keyes2019-03-26
- render_node() is now the main rendering function: it traverses a node and builds the Vim help text recursively. - render_para() is weird and ugly, it is the entry-point for rendering the help text for one docstring'd function.
generated by cgit (git 2.34.1) at 2025-04-29 01:52:34 +0000