rhys-vdw / rhys-vdw/lua-doc-extractor
How to handle generic return from a method
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 3
- Avg merge
- 2m
- Merged PRs (30d)
- 1
Description
/***
* Get the underlying table. Note: Implemented in next release as of May 9 2025. See [PR](https://github.com/beyond-all-reason/RecoilEngine/pull/2241)
* @generic T
* @function RmlUi.SolLuaDataModel<T>:__GetTable
* @return T
*/
This seems weird, not sure how to properly capture the generic from the class when defining a method on said class. Need to experiment.
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 with the C-style generic annotation example in the issue and inspect PR 2241, which is linked in the documentation comment. Determine how a generic declared on RmlUi.SolLuaDataModel should be represented for __GetTable; done means the intended generic return behavior and supported syntax are clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100