TASEmulators / TASEmulators/BizHawk
[docs] Lua libs need usage examples
Open
Nobody has claimed this yet.
Meta
re: Lua API/scripting
- Dominant language
- C#
- Stars
- 2.8k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
We shouldn't assume TASers are already proficient in Lua and can build a program from function headers.
Example code could be on the wiki / in another repo, or we could let other people do the work for us and link to it.
see also #2516
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 Lua scripts catalog linked in the issue and review #2516 for overlapping scope. Done means the targeted Lua libraries have usable examples on the wiki or another clearly maintained location, or have links to suitable external examples.
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
- 45/100