-
Notifications
You must be signed in to change notification settings - Fork 44
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(tut): Add cross ref to chapter 6 #550
Conversation
20fb77e
to
b6627e7
Compare
This helps when users try to use the docs as a reference to solve their issue at hand (as opposed to reading in order and remembering everything).
b6627e7
to
415182e
Compare
Pull Request Test Coverage Report for Build 9652374114Details
💛 - Coveralls |
I don't think that "coveralls" report is correct. I haven't changed any of the files it claims have new missed lines... |
//! As a reminder [`chapter_6`] demonstrated how to convert a [`PResult`] to a standard | ||
//! Rust [`Result`], and this section assumes that has been done. | ||
//! |
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.
I feel this doesn't quite serve the intended role.
- Everything up to this point was already relying on this in this chapter
- If we had this, I feel like it should call out the mechanism whereby this is done or else it feels like its pointing back to nothing
- I believe our callbacks like this are usually done when we reference much earlier chapters. What some chapters do for this type of thing is, at the very type, have a transition statement. For example, we could have something like "With
Parser::parse
convertingPResult
intoResult
for use in our application, let's see how we can polish the quality of the reported error message". Note that that example statement is meant only to serve as an example and I created it without much deep thought.
Change apparently not wanted at all (seemed like an outright reject rather than suggestions for how to improve the PR) and I don't have time to work on this. |
To be clear, I gave a first-order approximation of how this could be reworked
|
This helps when users try to use the docs as a reference to solve their issue at hand (as opposed to reading in order and remembering everything).
Related to discussion #544