-
Notifications
You must be signed in to change notification settings - Fork 13.2k
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
Clarify MaybeUninit docs #138005
base: master
Are you sure you want to change the base?
Clarify MaybeUninit docs #138005
Conversation
/// according to the requirements of the variable's type. For example, a variable of | ||
/// reference type must be aligned and non-null. This is an invariant that must | ||
/// Every variable must be properly initialized according to the requirements of its type. | ||
/// For example, a variable of reference type must be aligned and non-null. This is an invariant that must |
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.
You're still dong changes here without explaining the rhyme or reason for them. What is wrong with the sentence that you changed here, the first sentence of this section?
Sorry, I'm already swamped with reviews, I really don't have the time to tease out the meaningful changes from the gratuitous rewordings in a PR like this.
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.
The idea here is to remove the distraction of mentioning the compiler. (Since it is really the language definition that matters, not what the compiler assumes...)
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.
That is the rigorous way of talking about it, but not the most accessible way. We have to be careful not to turn the docs into unreadable (to most of the audience) legalese.
r? libs-api |
Please decide how yo want to continue with this: close one of #136689 or this PR, and then for the remaining PR, if you want me to review it I'd like you to explain every single change on a paragraph-by-paragraph basis. If that feels like too much, you're doing too many changes in one PR, so please cut it down -- there can always be a next PR. Smaller PRs are a lot easier to review. |
☔ The latest upstream changes (presumably #138714) made this pull request unmergeable. Please resolve the merge conflicts. |
This is an attempt at excluding less impactful changes from #136689.
r? @RalfJung