-
-
Notifications
You must be signed in to change notification settings - Fork 873
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
docs: Improve documentation at Klondike Tutorial Step 5 #3078
base: main
Are you sure you want to change the base?
Conversation
I am still working there. Please feel free to discuss about this PR |
2e47588
to
bf1592a
Compare
@@ -413,6 +413,141 @@ FlameGame. The new world contains (almost) everything we need to play the game a | |||
re-created during each of the above actions. | |||
|
|||
|
|||
### KlondikeWorld class | |||
|
|||
In Flame, a ```World``` is a type of ```Component``` that can contain other ```Components```, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These should only have a single back-tick, tripple back-ticks are for multi-line code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure! Let me change this
@nickf2k any update on this? |
Description
This PR for solving the issue #3076
1. What would I do to improve this tutorial:
2. Contents I will add or modify:
I believe these sections are satisfactory, so I won't make any edits to them. I will begin editing from the section: A New World.
Immediately after the
Start and restart actions
section, I will provide an explanation of the "KlondikeWorld" class. Consequently, the adjustment of the "KlondikeGame" class is merely a necessary step when migrating the onLoad() function to KlondikeWorld, rendering the "A stripped-down KlondikeGame class" section redundant.The section
Using a Random Number Generator seed
appears reasonable. However, I intend to supplement more references to this definition of "seed." If you have any documents or suggestions on this topic, please provide further information. Otherwise, I will utilize the following link: Link to Reddit.The section
Introducing the new KlondikeWorld class
was previously covered, hence it will be omitted here. Please note that I will enrich the previous instruction with additional details.Button
: I will retain and expand upon this section as it lacks significant information.Anchors and coordinates
: This section may be considered supplementary information within the Button section. Therefore, I will incorporate and merge it into the Button section.The deal() method
: I will maintain this section in its current position, perhaps making minor sentence edits or none at all.More animations of moves
: Similar to the section "The deal() method."A graphics glitch
: As above.Winning the game
: I find this section quite comprehensive; hence, I may not make any alterations.Ending a game and restarting it
: This section lacks crucial details and is rather confusing. I will rewrite it to clarify.Have fun button
: This section is well-structured; therefore, I may retain it with minor adjustments if necessary.Checklist
docs
and added dartdoc comments with///
.examples
ordocs
.Breaking Change?
Related Issues
This PR solve the issue #3076