LuaLS / LuaLS/lua-language-server

Documentation doesn't contain the descriptions of classes.

Ouverte
#3,138 0 commentaires 0 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?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Other

Expected Behaviour

Example input:

Image

Expecting output like:

#Action

<fields & methods>

Actual Behaviour

Example output:

Image

Here's what I see when mousing over it in VSCode:

Image

Reproduction steps

Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.

Additional Notes

No response

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

Commencez par le chemin LuaLS CLI qui génère la documentation et reproduisez le problème à l’aide de l’exemple documenté. Comparez la sortie générée avec la description attendue de la classe, des champs et des méthodes ; le travail est terminé lorsque les descriptions sont conservées dans la documentation générée.

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
45/100

Recevez les nouvelles issues par e-mail

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