rhys-vdw / rhys-vdw/lua-doc-extractor
Support parsing multi-line union with comments
Open
Nobody has claimed this yet.
bug
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 3
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
/***
* @param someValues
* | 1 # One
* | 2 # Two
* | 3 # Three
* @function foo
*/
Alternative syntax:
---@alias Foo
---Hello
---| "H"
---Goodbye
---| "G"
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 reproducing the C-style and Lua documentation examples from the issue and trace the parser entry point that handles union declarations. Done means multi-line union members are parsed correctly when inline comments or intervening comment lines are present, for both shown syntaxes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100