LuaLS / LuaLS/lua-language-server
`--doc` writes lua's documentation instead of given module's
Ouverte
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?
Command Line
Which OS are you using?
Windows WSL
What is the issue affecting?
Other
Expected Behaviour
Producing documentation for the given module
Actual Behaviour
Producing documentation for lua's builtin functions
Reproduction steps
- Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
- Execute
lua-language-server --doc=. --doc_out_path=. - Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes
Tested on 3.13.5.
Log File
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
Commencez par la commande lua-language-server --doc et suivez la manière dont --doc=. et --doc_out_path=. sélectionnent le module d’entrée et les fichiers de sortie. Reproduisez le problème avec le fichier module.lua fourni, puis vérifiez que doc.md et doc.json décrivent ce module plutôt que les fonctions intégrées de Lua.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- cli, 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