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

Fix game typedoc annotations #254

Merged
merged 12 commits into from
Nov 14, 2023
Merged

Conversation

gok99
Copy link
Contributor

@gok99 gok99 commented Oct 10, 2023

Description

Game typedoc documentation was broken. Module context is now imported, so we can move functions out of the wrapper function which will allow proper typedoc annotations.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Generate documentation with yarn run docs and check that the test programs in the game module use guide (in wiki of this repo) works in the game scene.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Copy link

@lhw-1 lhw-1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thanks for the cleanup @gok99! Apart from some nits, looks good to go 👍

src/bundles/game/functions.ts Show resolved Hide resolved
src/bundles/game/types.ts Show resolved Hide resolved
@martin-henz martin-henz merged commit 05f5791 into source-academy:master Nov 14, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants