LuaLS / LuaLS/lua-language-server

Regular comments (i.e. `-- comment`) shouldn't be included in documentation

Abierto
#2,764 19 comentarios 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

need discuss
Lenguaje dominante
Lua
Estrellas
4.4k
Forks
442
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

How are you using the lua-language-server?

NeoVim

Which OS are you using?

MacOS

What is the issue affecting?

Hover

Expected Behaviour
-- THIS IS NOT A DOC COMMENT
---This is a doc comment
local a = ''

Hovering a should show: This is a doc comment.

Actual Behaviour
-- THIS IS NOT A DOC COMMENT
local a = ''

Hovering a shows:

THIS IS NOT A DOC COMMENT
This is a doc comment
Reproduction steps

See above ^^^

Additional Notes

No response

Log File

No response

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con el ejemplo de Lua del issue y reproduce la salida del hover en NeoVim. Sigue el procesamiento de la documentación del hover para determinar por qué los comentarios regulares -- se incluyen junto con los comentarios ---; estará terminado cuando al pasar el cursor sobre a solo se muestre This is a doc comment.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
lua
Área
devtools
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.