LuaLS / LuaLS/lua-language-server

Automatic doc generation builds incorrectly assumingly large types as a return value

Aberta
#1,617 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

enhancement
Linguagem predominante
Lua
Estrelas
4.4k
Forks
442
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Windows

What is the issue affecting?

Annotations, Completion

Expected Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"|"table"|"userdata"|"thread"
local function myAwesomeFunction(value)
	return type(value)
end
Actual Behaviour
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"...(+3)
local function myAwesomeFunction(value)
	return type(value)
end
Reproduction steps

Copy the code

---
local function myAwesomeFunction(value)
	return type(value)
end

execute autocompletion from ---.

Additional Notes

Probably not a very important issue.

Log File

No response

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Reproduza o problema na extensão do Visual Studio Code usando o exemplo de Lua e acione o autocompletar a partir de ---. Compare a anotação ---@return gerada com a união completa mostrada no comportamento esperado; considera-se concluído quando tipos de retorno grandes não forem mais abreviados com ...(+3).

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
lua, vscode
Domínio
devtools
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.