Missing get_progress_messages() documentation

j-hui · February 20, 2022, 9:34pm

I’m looking for documentation for vim.lsp.util.get_progress_messages(), but cannot find it.

On Neovim 0.6.0 and 0.6.1, the documentation for LspProgressUpdate refers to that help tag but it does not appear to be available:

LspProgressUpdate                                          *LspProgressUpdate*
   Upon receipt of a progress notification from the server. See
   |vim.lsp.util.get_progress_messages()|.

Am I missing something, or can someone point me to the right place? Thanks!

mjlbach · February 20, 2022, 9:41pm

There’s no documentation, the help tag can be removed. The function is quite simple, and marked private:

github.com

mjlbach/neovim/blob/f7c2cb3b2fc2b4e9f9bc569b229f2ce738c54d5f/runtime/lua/vim/lsp/util.lua#L300-L359

      
        
            --- Process and return progress reports from lsp server
            ---@private
            function M.get_progress_messages()
            
            
  local new_messages = {}
              local msg_remove = {}
              local progress_remove = {}
            
            
  for _, client in ipairs(vim.lsp.get_active_clients()) do
                  local messages = client.messages
                  local data = messages
                  for token, ctx in pairs(data.progress) do
            
            
        local new_report = {
                      name = data.name,
                      title = ctx.title or "empty title",
                      message = ctx.message,
                      percentage = ctx.percentage,
                      done = ctx.done,
                      progress = true,

This file has been truncated. show original

Topic		Replies	Views
Repetitive LSP Diagnostic messages on the same single line Language Server Protocol (LSP)	2	842	January 5, 2022
Ltex LSP spamming progress notifications Language Server Protocol (LSP)	2	319	June 28, 2024
Errors from python-lsp-server Language Server Protocol (LSP)	0	1227	March 24, 2022
Vim global object (or table) completion is approximate Language Server Protocol (LSP)	2	522	December 5, 2021
Is is possible to configure lsp hover to display documentation that occurs below the definition Language Server Protocol (LSP)	0	323	October 1, 2021

Missing get_progress_messages() documentation

Related topics