mirror of
https://github.com/neovim/neovim.git
synced 2024-12-19 18:55:14 -07:00
6c35fb421e
Style improvements: 1. Anonymous classes derived from `StructureLiteralType` should have a better name. The class name can be also nested. Examples: ```diff ----@field serverInfo? anonym1 +---@field serverInfo? lsp._anonym1.serverInfo ``` ```diff ----@field insertTextModeSupport? anonym26 +---@field insertTextModeSupport? lsp._anonym26.completionItem.insertTextModeSupport ``` 2. Add one separate empty line before each `@field` definition. Without these, empty lines the doc can look confusing because descriptions also may contain empty lines. See `lsp.CompletionItem` for example: ```lua ---The kind of this completion item. Based of the kind ---an icon is chosen by the editor. ---@field kind? lsp.CompletionItemKind ---Tags for this completion item. --- ---@since 3.15.0 ---@field tags? lsp.CompletionItemTag[] ``` It might feel like "Tags for this completion item" belongs to `kind`, not `tags` due to the lack of separator blank lines. The following (after this commit) should look much better: ```diff ---The kind of this completion item. Based of the kind ---an icon is chosen by the editor. ---@field kind? lsp.CompletionItemKind +--- ---Tags for this completion item. --- ---@since 3.15.0 ---@field tags? lsp.CompletionItemTag[] ``` 3. Escape some LSP-specific annotations that can't be recognized by lua-ls. It'd be better to make them visible in LSP hover doc windows. Example: `@sample ...`. Fixes: 1. A type may extend from more than one base types (as well as mixin types). Previously only the first base class was being considered, resulting incomplete base classes for `@class` definitions. Example: `InlayHintOptions` (should have both of `resolveProvider` and `workDoneProgress`, the latter is from `WorkDoneProgressOptions`) ```diff ----@class lsp.InlayHintOptions +---@class lsp.InlayHintOptions: lsp.WorkDoneProgressOptions ``` 2. Remove `<200b>` (zero-width space) unicode characters. 3. Add the missing newline at EOF. |
||
|---|---|---|
| .. | ||
| bump_deps.lua | ||
| check_urls.vim | ||
| cliff.toml | ||
| download-unicode-files.sh | ||
| gen_eval_files.lua | ||
| gen_filetype.lua | ||
| gen_help_html.lua | ||
| gen_lsp.lua | ||
| gen_vimdoc.py | ||
| genappimage.sh | ||
| git-log-pretty-since.sh | ||
| legacy2luatest.pl | ||
| lintcommit.lua | ||
| lua2dox.lua | ||
| movedocs.pl | ||
| release.sh | ||
| shadacat.py | ||
| update_terminfo.sh | ||
| vim-patch.sh | ||
| vimpatch.lua | ||
| windows.ti | ||