Skip to content
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

fix small ambiguity in tutorial #14806

Closed
zooko opened this issue Jun 11, 2014 · 3 comments
Closed

fix small ambiguity in tutorial #14806

zooko opened this issue Jun 11, 2014 · 3 comments

Comments

@zooko
Copy link
Contributor

zooko commented Jun 11, 2014

I momentarily misparsed this, thinking that lending X a reference to Y would freeze X. This patch fixes it for me:

diff --git a/src/doc/tutorial.md b/src/doc/tutorial.md
index b712294..5727141 100644
--- a/src/doc/tutorial.md
+++ b/src/doc/tutorial.md
@@ -1473,7 +1473,7 @@ For a more in-depth explanation of references and lifetimes, read the

 ## Freezing

-Lending an &-pointer to an object freezes it and prevents mutation—even if the object was declared as `mut`.
+Lending an &-pointer to an object freezes the pointed-to object and prevents mutation—even if the object was declared as `mut`.
 `Freeze` objects have freezing enforced statically at compile-time. An example
 of a non-`Freeze` type is [`RefCell<T>`][refcell].
@steveklabnik
Copy link
Member

Thank you! Would you mind submitting it as a pull request?

steveklabnik added a commit to steveklabnik/rust that referenced this issue Jun 23, 2014
@steveklabnik
Copy link
Member

Nevermind, I just did it myself :) Thanks for pointing it out!

alexcrichton pushed a commit to alexcrichton/rust that referenced this issue Jun 25, 2014
@zooko
Copy link
Contributor Author

zooko commented Jun 25, 2014

So can we close this issue ticket now?

@zooko zooko closed this as completed Jun 25, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants