luttje / luttje/glua-api-snippets
Default Lua functions should not always be extracted
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 45
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
> Unrelated to this, but I feel like nothing should be generated for these standard library functions which are already documented by LuaLS.
>
> You get generics and a more in-depth description of them with LuaLS anyway.
>
> Although I see that may be problematic for entries like https://wiki.facepunch.com/gmod/Global.pcall which do add onto the description with gmod-specific info.
_Originally posted by @Vurv78 in https://github.com/luttje/glua-api-snippets/issues/19#issuecomment-1675560504_
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
No source file, test, or entry point is named. Start by locating the extraction logic and comparing LuaLS standard-library coverage with Garry's Mod-specific additions; done means avoiding redundant standard functions while preserving entries such as Global.pcall that add GMod-specific information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100