LuaLS / LuaLS/lua-language-server

`--doc` writes lua's documentation instead of given module's

Ouverte
#3,002 5 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?

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
  1. Create & cd into empty folder with a module.lua inside:
---@param x number
function foo(x) end
  1. Execute lua-language-server --doc=. --doc_out_path=.
  2. Get the doc.md & doc.json containing lua docs instead of module docs
Additional Notes

Tested on 3.13.5.

Log File

file_home_girvel_tmp_..log
service.log

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 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

Recevez les nouvelles issues par e-mail

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