LuaLS / LuaLS/lua-language-server
Documentation doesn't contain the descriptions of classes.
Open
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
How are you using the lua-language-server?
Visual Studio Code Extension (sumneko.lua)
Which OS are you using?
Linux
What is the issue affecting?
Other
Expected Behaviour
Example input:
Expecting output like:
#Action
<fields & methods>
Actual Behaviour
Example output:
Here's what I see when mousing over it in VSCode:
Reproduction steps
Build docs using LuaLSP's CLI, see that descriptions get stripped/not output.
Additional Notes
No response
Log File
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the LuaLS CLI path that builds documentation and reproduce the issue using the documented example. Compare the generated output with the expected class description, fields, and methods; done means descriptions are retained in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100