LuaLS / LuaLS/lua-language-server

Irritating Markdown syntax for headings conflicts with traditional comment frames in Lua

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

Ninguém assumiu esta issue ainda.

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?

Linux

### What is the issue affecting?

Annotations

### Expected Behaviour

"Hello World!" in the following annotation is NOT treated as a heading:
```
--------------------------------------------------------------------------------
--- Hello World!
--------------------------------------------------------------------------------
local function Main() end
```

### Actual Behaviour

"Hello World!" shows as a heading in the documentation pop-up window like so.

### Reproduction steps

Type the following code and hover your mouse over the function name.
```
--------------------------------------------------------------------------------
--- Hello World!
--------------------------------------------------------------------------------
local function Main() end
```

### Additional Notes

As someone who likes to frame documentation comments, I find this issue unbearable. The reason we should except Markdown's dash `----` syntax for headings in LuaCATS is because Lua uses dashes to delimit the comments themselves. And those who frame comments also use the same character (dash) for the rest of the frame. You wouldn't use another character for the frame, it would look ugly and not uniform. For example, in C, Markdown's heading syntax does not conflict with the comment delimiter (`//`). So you can frame your comments by repeating the comment delimiter itself for a uniform frame.

### Log File

Log files have no use in this issue.

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 passando o cursor sobre a função na anotação Lua emoldurada mostrada no relatório. Comece localizando o tratamento de títulos Markdown do LuaCATS usado para a documentação de anotações e, em seguida, verifique se o texto emoldurado “Hello World!” não é mais renderizado como um título, enquanto os títulos Markdown comuns continuam funcionando.

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

Avaliação

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

Receba novas issues na sua caixa de entrada

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