LuaLS / LuaLS/lua-language-server

[Feature Request] Add additional fields to exported docs

Open
#2,416 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the exported documentation JSON implementation and the code that assembles fields for functions, methods, and fields. Review how inheritance, file paths, descriptions, and deprecation are currently represented; done would require an agreed scope and tests covering the selected export fields and nodoc or inheritance behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.