LuaLS / LuaLS/lua-language-server

[Feature Request] Add additional fields to exported docs

Ouverte
#2,416 1 commentaire 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

Right now, it's very difficult to parse the exported docs. I've mostly been able to figure stuff out, but there's a bit of information the exported JSON file does not expose, which I would like to suggest.

- A field for which class something originates from, to filter out unchanged methods/fields from parents
- A relative version of `file`, instead of an absolute path
- [x] A version of the description which does not include markdown for params and return values, since those are separate
- Whether a function is deprecated or not
- A way to hide a field or method from the docs export (`---@nodoc`?)
- Maybe a way to not export inherited fields/methods? The exported file for my project is more than a million lines long...

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 localiser l’implémentation du JSON de documentation exporté et le code qui assemble les champs pour les fonctions, les méthodes et les champs. Examinez comment l’héritage, les chemins de fichiers, les descriptions et l’obsolescence sont actuellement représentés ; le travail sera considéré comme terminé lorsqu’un périmètre convenu et des tests couvrant les champs d’exportation sélectionnés ainsi que le comportement de nodoc ou de l’héritage seront disponibles.

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é
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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