LuaLS / LuaLS/lua-language-server
Request for ability to skip adding to documentation, i.e. `---@nodoc`
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
At the moment, if I do anything that references _G, all of the documentation for _G populates the documentation. It would be nice to be able to prevent superfluous documentation - especially for stuff that's only local to the file and not exported for public use.
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 retracer la manière dont la documentation est collectée lorsqu’un fichier fait référence à _G, puis identifiez l’endroit où un marqueur ---@nodoc pourrait être reconnu. Le travail est terminé lorsque les symboles locaux ou autrement non publics peuvent être exclus de la documentation générée sans supprimer la documentation des symboles publics ; l’issue ne nomme aucun fichier ni aucun test, ces points d’entrée doivent donc d’abord être localisés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- lua
- Domaine
- documentation
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100