TASEmulators / TASEmulators/BizHawk
LuaCanvas docs should show (some?) inherited methods
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.8k
- Forks
- 468
- PR merge metrics
- No merged PRs in 30d
Description
Could override methods, adding the docs attribute and delegating to base implementation.
https://github.com/TASEmulators/BizHawk/blob/1a30f6551ed66418d4760cc0739f620be2faba46/src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs#L118
https://github.com/TASEmulators/BizHawk/blob/1a30f6551ed66418d4760cc0739f620be2faba46/src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs#L34-L37
see also #4155
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 src/BizHawk.Client.EmuHawk/tools/Lua/LuaLibraries.cs around lines 34-37 and 118, then review the related discussion in #4155. Determine which LuaCanvas inherited methods should be exposed in the generated documentation and verify that the selected methods appear there when the documentation change is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100