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

Rust Rules #644

Closed
davidde opened this issue Apr 24, 2017 · 6 comments
Closed

Rust Rules #644

davidde opened this issue Apr 24, 2017 · 6 comments

Comments

@davidde
Copy link
Contributor

davidde commented Apr 24, 2017

I noticed that while learning and programming Rust, I often need to refer back to some of the rules, for instance lifetime elision or borrowing. Since there is no central place where to find them, I often lose some time in tracking down in what part they are located. I think it would be very beneficial for Rust learners to have such a place where all the rules are listed, both for reference, as well as to develop an intuition / mental framework for them. It makes it easier to keep them all in your head, and maintain the bigger picture.

So what I'm actually proposing is a new appendix part where all the rules are listed: borrowing rules, lifetime elision, dereference and deref coercion, object safety, module rules (file systems and privacy), etc.

I expect the book to be used both as a tutorial and a reference for learners, and I believe a Rules section would make the book a better tool for the people it caters to: programmers learning Rust.

@carols10cents
Copy link
Member

Interesting. There will be an index in the print version, which should help somewhat, we'll think about whether we should pull these sorts of things out into an appendix as well. Thank you for the suggestion! 🌮

@davidde
Copy link
Contributor Author

davidde commented Apr 24, 2017

No problem. Happy it will be considered.

@kellyjensen
Copy link

I too would find this highly valuable.

@davidde
Copy link
Contributor Author

davidde commented Apr 25, 2017

Thank you for speaking up! That's exactly how I feel ;)

@sondr3
Copy link

sondr3 commented Apr 26, 2017

I would love this as well :)

@carols10cents
Copy link
Member

After considering this, I think it will be addressed sufficiently in the print edition with the index, in the online edition with search, and perhaps an online-only supplement to the book that anyone could create.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants