Add FIXMEs

runtime/lua/vim/lsp.lua

@@ -238,6 +238,8 @@ local function text_document_did_open_handler(bufnr, client)
   util.buf_versions[bufnr] = params.textDocument.version
 end
 
+-- FIXME: DOC: Shouldn't need to use a dummy function
+--
 --- LSP client object. You can get an active client object via
 --- |vim.lsp.get_client_by_id()| or |vim.lsp.get_active_clients()|.
 ---
@@ -308,12 +310,12 @@ function lsp.client()
   error()
 end
 
--- FIXME: Currently all methods on the `vim.lsp.client` object are documented
--- twice: Here, and on the methods themselves (e.g. `client.request()`). This
--- is a workaround for the vimdoc generator script not handling method names
--- correctly. If you change the documentation on either, please make sure to
--- update the other as well.
-
+-- FIXME: DOC: Currently all methods on the `vim.lsp.client` object are
+-- documented twice: Here, and on the methods themselves (e.g.
+-- `client.request()`). This is a workaround for the vimdoc generator script
+-- not handling method names correctly. If you change the documentation on
+-- either, please make sure to update the other as well.
+--
 --- Starts and initializes a client with the given configuration.
 ---
 --- Parameters `cmd` and `root_dir` are required.

runtime/lua/vim/lsp/callbacks.lua

@@ -7,6 +7,8 @@ local buf = require 'vim.lsp.buf'
 
 local M = {}
 
+-- FIXME: DOC: Expose in vimdocs
+
 --@private
 --- Writes to error buffer.
 --@param ... (table of strings) Will be concatenated before being written

runtime/lua/vim/lsp/log.lua

@@ -2,6 +2,9 @@
 
 local log = {}
 
+-- FIXME: DOC
+-- Should be exposed in the vim docs.
+--
 -- Log level dictionary with reverse lookup as well.
 --
 -- Can be used to lookup the number from the name or the name from the number.
@@ -38,6 +41,9 @@ do
   for level, levelnr in pairs(log.levels) do
     -- Also export the log level on the root object.
     log[level] = levelnr
+    -- FIXME: DOC
+    -- Should be exposed in the vim docs.
+    --
     -- Set the lowercase name as the main use function.
     -- If called without arguments, it will check whether the log level is
     -- greater than or equal to this one. When called with arguments, it will

runtime/lua/vim/lsp/rpc.lua

@@ -368,7 +368,9 @@ local function start(cmd, cmd_args, handlers, extra_spawn_params)
     return true
   end
 
-  -- FIXME: Should be placed on the RPC client object returned by `start()`
+  -- FIXME: DOC: Should be placed on the RPC client object returned by
+  -- `start()`
+  --
   --- Sends a notification to the LSP server.
   --@param method (string) The invoked LSP method
   --@param params (table): Parameters for the invoked LSP method
@@ -393,7 +395,9 @@ local function start(cmd, cmd_args, handlers, extra_spawn_params)
     }
   end
 
-  -- FIXME: Should be placed on the RPC client object returned by `start()`
+  -- FIXME: DOC: Should be placed on the RPC client object returned by
+  -- `start()`
+  --
   --- Sends a request to the LSP server and runs {callback} upon response.
   ---
   --@param method (string) The invoked LSP method

runtime/lua/vim/lsp/util.lua

@@ -7,7 +7,7 @@ local highlight = require 'vim.highlight'
 
 local M = {}
 
--- FIXME: Expose in documentation
+-- FIXME: DOC: Expose in vimdocs
 --- Diagnostics received from the server via `textDocument/publishDiagnostics`
 -- by buffer.
 --