Quenty / Quenty/NevermoreEngine
Signal and OldSignal have conflated docs
Nobody has claimed this yet.
- Dominant language
- Lua
- Stars
- 610
- Forks
- 144
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 12
Description
These classes share an API page as a result of a naming collision. According to their Moonwave comments, Signal.lua defines GoodSignal, and OldSignal.lua defines Signal.
However, "Signal" is the actual class/table name in both files, so their members are aggregated under Signal, and GoodSignal exists as a member-less page.
Additionally, OldSignal attempts to redirect to GoodSignal, which doesn't exist given the current file name.
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
Inspect the Moonwave comments and class names in Signal.lua and OldSignal.lua first. Confirm how their API pages are generated and how the OldSignal redirect is resolved. Done means Signal and OldSignal have separate API documentation pages, with the documented class names and redirect resolving correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100