luttje / luttje/glua-api-snippets

Scrapper doesn't support functions with multiple/overloaded declarations.

Open
#87 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
45
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Scrapper doesn't support functions with multiple/overloaded declarations.
Example:
[surface.DrawCircle()](https://wiki.facepunch.com/gmod/surface.DrawCircle)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the scraper against the linked surface.DrawCircle() wiki page and inspect how its multiple declarations are parsed. Trace the generated Lua Language Server comments and compare them with a function having one declaration. Done means overloaded or multiple declarations are represented correctly in the generated snippets.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.