fix: relocate paragraph, rename variable #311
Open
Conversation
This file contains hidden or 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
There are two changes here: 1. Rename `n_ref` to `i` because that's what the code shows. You can find source for the two related listings [08-07](https://github.com/cognitive-engineering-lab/rust-book/blob/main/listings/ch08-common-collections/listing-08-07/src/main.rs), and [08-08](https://github.com/cognitive-engineering-lab/rust-book/blob/main/listings/ch08-common-collections/listing-08-08/src/main.rs) 2. There is a paragraph explaining that we read the value with `*i` which confuses readers where it is located. So I moved it just to the next listing, where it is _actually_ used. I've tried other solutions like removing it entirely or rephrasing it, but this seems to me to involve the least changes and be most fit.
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.
There are two changes here:
n_reftoibecause that's what the code shows. I do get thatn_refwas more pedagogical. But currently is just confusing.i.*iwhich confuses readers where it is located. So I moved it just to the next listing, where it is actually used.Note that no paragraph was deleted, it's just relocated (the diff may be confusing).
I've tried other solutions like removing it entirely or rephrasing it, but this seems to me to involve the least changes and be most fit.
cc: @willcrichton
closes #310