From ac05343a1023874243ee9fdd490c21c42a737157 Mon Sep 17 00:00:00 2001 From: Patrice Peterson Date: Wed, 19 Aug 2020 18:17:08 +0200 Subject: Add docs for most vim.lsp methods Most of the lsp.log will be addressed in a separate PR. --- runtime/lua/vim/lsp/log.lua | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'runtime/lua/vim/lsp/log.lua') diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua index 696ce43a59..f19367851f 100644 --- a/runtime/lua/vim/lsp/log.lua +++ b/runtime/lua/vim/lsp/log.lua @@ -21,12 +21,14 @@ local log_date_format = "%FT%H:%M:%S%z" do local path_sep = vim.loop.os_uname().sysname == "Windows" and "\\" or "/" + --@private local function path_join(...) return table.concat(vim.tbl_flatten{...}, path_sep) end local logfilename = path_join(vim.fn.stdpath('data'), 'lsp.log') - --- Return the log filename. + --- Returns the log filename. + --@returns (string) log filename function log.get_filename() return logfilename end @@ -74,6 +76,8 @@ end -- interfere with iterating the levels vim.tbl_add_reverse_lookup(log.levels) +--- Sets the current log level. +--@param level (string or number) One of `vim.lsp.log.levels` function log.set_level(level) if type(level) == 'string' then current_log_level = assert(log.levels[level:upper()], string.format("Invalid log level: %q", level)) @@ -84,8 +88,9 @@ function log.set_level(level) end end --- Return whether the level is sufficient for logging. --- @param level number log level +--- Checks whether the level is sufficient for logging. +--@param level number log level +--@returns (bool) true if would log, false if not function log.should_log(level) return level >= current_log_level end -- cgit From b5782c3b8185553f29e1fc66ae2be7681296ece3 Mon Sep 17 00:00:00 2001 From: Patrice Peterson Date: Sun, 23 Aug 2020 13:28:56 +0200 Subject: Add FIXMEs --- runtime/lua/vim/lsp/log.lua | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'runtime/lua/vim/lsp/log.lua') diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua index f19367851f..587a65cd96 100644 --- a/runtime/lua/vim/lsp/log.lua +++ b/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 -- cgit