rhys-vdw / rhys-vdw/lua-doc-extractor

Support `@class Foo:Bar` annotation (no spaces)

Open
#59 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
TypeScript
Stars
2
Forks
3
Avg merge
2m
Merged PRs (30d)
1

Description

Currently this fails:

/*** @class Foo:Bar */

This is class inheritance of Foo : Bar.

Contributor guide

No contributing guide indexed for this repository

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

No implementation file or test is named in the issue. Start by locating the parser entry point that handles @class annotations, then reproduce the exact C-style comment shown; done means the no-space Foo:Bar form is accepted as Foo inheriting from Bar and is covered by a regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, typescript
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.