LuaLS / LuaLS/lua-language-server
Irritating Markdown syntax for headings conflicts with traditional comment frames in Lua
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?
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Reproduisez le problème dans l’extension Visual Studio Code en survolant la fonction de l’annotation Lua encadrée présentée dans le rapport. Commencez par localiser la gestion des titres Markdown de LuaCATS utilisée pour la documentation des annotations, puis vérifiez que le texte encadré « Hello World! » n’est plus rendu comme un titre, tandis que les titres Markdown ordinaires fonctionnent toujours.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100