-
Notifications
You must be signed in to change notification settings - Fork 13.1k
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
Reorganize doc index, add pointer guide #11364
Conversation
} | ||
~~~ | ||
|
||
But won't this be inefficent? Well, that's a complicated question, but it's |
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.
Inefficiency isn't the only reason to pass by reference: ownership is the main one, and I feel this section is totally ignoring that.
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.
Agreed; most tutorial (e.g. for C) introduce pointers as a way to pass a variable to a function to edit it directly (well also as a way to workaround the inability to return multiple values in the case of C, which does not have tuples).
Maybe this can be adressed later on.
Thanks for the spellcheck everyone! At the time I wrote this, I thought it was enabled, but wasn't. :/ Yay typos! All these changes seem good. |
I will make all the recommended changes in a followup. |
This reorganizes the documentation index to be more focused on the in-tree docs, and to clean up the style, and it also adds @steveklabnik's pointer guide.
It looks like these comments are addressed in #11388? |
Not all. But I think #11397 addresses the rest. |
Can confirm, #11397 addresses all of the typos and markdown errors that I could find. |
This reorganizes the documentation index to be more focused on the in-tree docs, and to clean up the style, and it also adds @steveklabnik's pointer guide.