LuaLS / LuaLS/lua-language-server
Documentation export is missing information
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
What is the issue affecting?
Other
Expected Behaviour
After generating documentation with --doc, I expected to have access to the all of the information available in the annotations that is presented or used by the language server.
Actual Behaviour
There were a few things that are missing or strange:
@seeannotations are absent.- Access levels (
@protected,@private,@package) are absent. - Aliases that extend other aliases include the documentation of the alias that they extend, which makes it difficult to tell which documentation belongs to only the extended alias.
- The
startandfinishfields seem odd; they're very large numbers (e.g., 5490009, 5490021) that clearly don't refer to character ranges within the files. What are these numbers?
For the purpose of generating documentation, the first two problems seem significant—it would be difficult to filter out private fields and methods, for example.
Reproduction steps
- Create a Lua file that uses access modifiers,
@see, and an alias that extends another alias. I've provided a minimal example of such a file below. - Observe the missing data and oddities.
Additional Notes
Example for reproduction:
---@class C
---@field private z integer
local C = {}
---Base alias doc comment.
---@alias Base
---| 'A'
---| 'B'
---Extended alias doc comment.
---@alias Derived
---| Base
---| 'C'
---@protected
function C.x()
end
---@see C.x
function C.y()
end
Log File
No response
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 exécuter l’export --doc sur la reproduction en Lua de l’issue et examinez comment sa sortie représente @see, les modificateurs d’accès, la documentation d’alias héritée et start/finish. Suivez le point d’entrée de l’export de documentation et comparez sa sortie avec les informations d’annotation utilisées par le serveur de langage. Le travail est terminé lorsque les données exportées préservent les détails d’annotation demandés et expliquent ou corrigent les valeurs de plage.
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é
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100