TASEmulators / TASEmulators/BizHawk
Stop returning Lua tables with 0-indexing
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.8k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
These are non-idiomatic and annoying to work with (though IMO the normal 1-indexed tables are also annoying).
Switching a function's indexing is a breaking change, so we should plan to change them all at once. The candidates are:
client.getavailabletools()comm.mmfReadBytes(string, int)event.availableScopes()memory.getmemorydomainlist()- (deprecated)
memory.readbyterange(long, int, string?)/mainmemory.readbyterange(long, int) movie.getcomments()/movie.getsubtitles()tastudio.getbranches()/tastudio.getselection()
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 by locating the implementations and tests for client.getavailabletools(), comm.mmfReadBytes(), event.availableScopes(), memory domain and byte-range functions, movie comments and subtitles, and tastudio branch and selection functions. Review how each result is exposed to Lua and identify the existing indexing expectations. Done means all listed functions consistently stop returning 0-indexed tables, with coverage for the changed behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, lua
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100