-
Notifications
You must be signed in to change notification settings - Fork 46
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(tutorial): Clarify examples in chapter 5 #625
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nukesor
force-pushed
the
improve-chapter-5
branch
from
November 22, 2024 15:03
921adfe
to
69ec195
Compare
Pull Request Test Coverage Report for Build 11985707946Details
💛 - Coveralls |
Nukesor
force-pushed
the
improve-chapter-5
branch
3 times, most recently
from
November 22, 2024 15:05
f803043
to
d5e795d
Compare
epage
reviewed
Nov 22, 2024
Nukesor
force-pushed
the
improve-chapter-5
branch
2 times, most recently
from
November 22, 2024 15:09
e80ebf7
to
f8666ed
Compare
epage
reviewed
Nov 22, 2024
Thank you for taking the time to fix this to help others in the future! |
Nukesor
force-pushed
the
improve-chapter-5
branch
from
November 22, 2024 16:01
f8666ed
to
2ed606c
Compare
epage
reviewed
Nov 22, 2024
Nukesor
force-pushed
the
improve-chapter-5
branch
from
November 22, 2024 16:30
dd02478
to
e3461c1
Compare
Nukesor
force-pushed
the
improve-chapter-5
branch
from
November 23, 2024 08:35
e3461c1
to
1ae59c3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
While going through the tutorial, I found the description on the last example of chapter 5 very confusing.
As a beginner, at this point of the tutorial I had the mental model that a Parser always consumes/advdances the input.
Suddenly
take
is introduced without any further info, which uses checkpoints under the hood.And to make this even more confusing, the output of the
parse_list
parser is changed to "accumulat[e] the results into a()
", which really doesn't make a lot of sense if you don't know thattake
doesn't care about the output of the contained parser due to the checkpoint logic.There's really a lot of concepts to unwrap in this small piece of code and it took a bit of research to figure out why stuff worked the way it does.
I hope the new text is able to convey this knowledge in a better way.