Make scenario files LuaDoc/LDoc compatible
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 869
- Forks
- 222
- Avg merge
- 18h 33m
- Merged PRs (30d)
- 1
Description
LuaDoc comments (for functions and) for script files look like this:
--- Summary.
-- Description; this can extend over
-- several lines.
Unfortunately, EE scenarios currently start with -- Name: ... and changing this to --- hides the name of the scenario.
Make the beginning comments of scenario files LuaDoc/LDoc compatible.
It would be easy to adapt all existing scenarios. But maybe even a more tolerant interpretation can be found such that both variants work.
Not so obvious might be the interpretation of the following lines where --- is currently used for continued lines. Quite unusual.
Contributor guide
No contributing guide indexed for this repository
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 by locating the scenario-file comment parser and review how it currently treats -- Name: ... and --- continuation lines. Done means existing scenarios still expose their names while LuaDoc/LDoc-style beginnings, including multiline comments, are accepted; add or update coverage if the project has parser tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- game-dev
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100