Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type annotations #85

Open
tyoeer opened this issue Dec 23, 2022 · 1 comment
Open

Add type annotations #85

tyoeer opened this issue Dec 23, 2022 · 1 comment
Labels
a-idea Amount: Large things that will require more effort docs Improvements or additions to documentation internal Stuff that is not visible to end users, e.g. code quality

Comments

@tyoeer
Copy link
Owner

tyoeer commented Dec 23, 2022

Type annotations improve the IDE experience, and sumneko's LSP allows exporting of information through --doc.

  • In order to find constructors that need specifying, remove the vararg/... in the type boilerplate in main.lua
  • Subtypes don't work well with the current way of specifying :new()
@tyoeer
Copy link
Owner Author

tyoeer commented Dec 23, 2022

Class: all classes have been annotated as such, and have their supers set
New: the constructor has been provided types, and subtypes have been defined/annotated.
Desc: Class has a description
Methods: Methods have types (and description where relevant)

  • ui/
    • base/
      • class
      • new
      • desc
      • methods
    • widgets/
      • class
      • new
      • desc
      • methods
    • layout/
      • class
      • new WIP
      • desc
      • methods
    • tools/
      • class
      • new
      • desc
      • methods
  • levelhead/
    • campaign/
      • class WIP
      • new WIP
      • desc
      • methods
    • data/
      • class WIP
      • new WIP
      • desc
      • methods
    • level/
      • class
      • new
      • desc
      • methods
    • lhs/
      • class
      • new
      • desc
      • methods
    • The rest
      • class WIP
      • new WIP
      • desc
      • methods
  • tools/
    • class
    • new
    • desc
    • methods
  • chaoshead/
    • class WIP
    • new
    • desc
    • methods
  • Other stuff

@tyoeer tyoeer added docs Improvements or additions to documentation internal Stuff that is not visible to end users, e.g. code quality a-idea Amount: Large things that will require more effort labels Dec 25, 2022
@tyoeer tyoeer added s-misc Scope: shared/misc. stuff and removed s-misc Scope: shared/misc. stuff labels Jan 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-idea Amount: Large things that will require more effort docs Improvements or additions to documentation internal Stuff that is not visible to end users, e.g. code quality
Projects
None yet
Development

No branches or pull requests

1 participant