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.

Sign up for GitHub

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

Jump to bottom

docs: Refactor documentation for GameWidget #2344

Merged
merged 3 commits into from
Feb 17, 2023
Merged

docs: Refactor documentation for GameWidget #2344

merged 3 commits into from
Feb 17, 2023

Conversation

st-pasha
Copy link
Contributor

Description

Use the dartdoc directive for the GameWidget class, allowing us to keep the documentation in the code and on the site in sync.

Checklist

  • I have followed the Contributor Guide when preparing my PR.
  • [-] I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in docs and added dartdoc comments with ///.
  • [-] I have updated/added relevant examples in examples or docs.

Breaking Change?

  • [-] Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

erickzanardo
erickzanardo reviewed Feb 15, 2023
View reviewed changes
Copy link
Member

@erickzanardo erickzanardo left a comment

Choose a reason for hiding this comment

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

Awesome docs improvement, left one small comment

packages/flame/lib/src/game/game_widget/game_widget.dart Show resolved Hide resolved
@st-pasha st-pasha mentioned this pull request Feb 15, 2023
Merged
6 tasks
@spydon spydon merged commit 655824f into main Feb 17, 2023
@spydon spydon deleted the ps.game-widget-docs branch February 17, 2023 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@erickzanardo erickzanardo erickzanardo left review comments

@spydon spydon spydon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@st-pasha @spydon @erickzanardo