LuaLS / LuaLS/lua-language-server

Can't export documentation for functions

Ouverte
#2,015 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

I created a file with this content:

-- Test comment.
---@param x number
---@return number
return function(x)
  return x*2
end

Then I tried to export documentation from that file following this instruction, but got empty files in the output.

Classes are exported successfully, but how to export functions I do not understand.

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 l’instruction du wiki Export Documentation et reproduisez le problème à l’aide de l’exemple Lua du rapport. Comparez le cas de la fonction avec le cas de la classe exportée avec succès et déterminez pourquoi les fichiers de sortie sont vides ; le travail est terminé lorsque les fonctions documentées produisent une sortie exportée non vide.

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

Évaluation

Stack technique
lua
Domaine
documentation, tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

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