docs: Improve documentation at Klondike Tutorial Step 5 #3078
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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