LuaLS / LuaLS/lua-language-server

Additional blank lines are added to parameter descriptions in type annotations

Ouverte
#2,333 1 commentaire 8 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Lua
Étoiles
4.4k
Forks
442
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

How are you using the lua-language-server?

NeoVim

Which OS are you using?

MacOS

What is the issue affecting?

Hover

Expected Behaviour

For multiline descriptions in @param annotations to be displayed as if they were in a single line.

Actual Behaviour

When the description in a @param annotation spans multiple lines, a linebreak in inserted in the Markdown response, which breaks syntax highlighting:
image

Even after removing the preceding whitespace in the example above, formatting is still off:
image

Reproduction steps
  1. Create a lua file with the following content:
---@param bar any This is the description
---           for bar.
local function foo(bar) end
  1. Hover over foo.
  2. Notice the broken highlighting/formatting in the description of bar.
Additional Notes

Although VS Code doesn't have additional syntax highlighting, do note how the font style in explanation above) changes, which suggests that the issue is reproducible outside Neovim:
image

Log File

No response

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez le problème à partir de l’exemple Lua fourni en survolant foo dans NeoVim ou VS Code. Commencez par la réponse de hover et le chemin de formatage des descriptions @param multilignes ; le travail est terminé lorsque la description est rendue sur une seule ligne sans interrompre la coloration syntaxique Markdown dans les deux environnements signalés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
lua
Domaine
tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.