LuaLS / LuaLS/lua-language-server
Can't export documentation for functions
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Lua
- Stars
- 4.4k
- Forks
- 442
- PR merge metrics
- No merged PRs in 30d
Description
I created a file with this content:
-- Test comment.
---@param x number
---@return number
return function(x)
return x*2
end
Then I tried to export documentation from that file following this instruction, but got empty files in the output.
Classes are exported successfully, but how to export functions I do not understand.
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 Export Documentation wiki instruction and reproduce the issue using the Lua example in the report. Compare the function case with the successfully exported class case and determine why the output files are empty; done means documented functions produce non-empty exported output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100