Skip to content

clean up ptr docs #19651

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

Merged
merged 1 commit into from
Dec 22, 2014
Merged

clean up ptr docs #19651

merged 1 commit into from
Dec 22, 2014

Conversation

Gankra
Copy link
Contributor

@Gankra Gankra commented Dec 9, 2014

///
/// `copy_nonoverlapping_memory` is semantically equivalent to C's `memcpy`.
///
/// # Example
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're always using the plural currently, even if there's one example.

@Gankra Gankra force-pushed the ptr-docs branch 2 times, most recently from ff5fcf9 to 6e47400 Compare December 10, 2014 04:41
@Gankra
Copy link
Contributor Author

Gankra commented Dec 10, 2014

@steveklabnik @mahkoh I've re-worked the docs to match your suggestions. I also fixed corresponding intrinsic docs that I touched.

I didn't "optimize" the copy_memory example because it didn't seem that important. I just wanted to clarify some safety issues/rules for the most part.

@steveklabnik
Copy link
Member

I am okay with the format and such, so r=me if those who had comments about the content are happy.

@alexcrichton
Copy link
Member

Thanks @gankro! r=me with some small nits

@Gankra
Copy link
Contributor Author

Gankra commented Dec 19, 2014

@alexcrichton I think I've addressed your issues.

@alexcrichton
Copy link
Member

r=me, but there are some tidy failures

alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 21, 2014
@bors bors merged commit ce10c01 into rust-lang:master Dec 22, 2014
lnicola pushed a commit to lnicola/rust that referenced this pull request Apr 28, 2025
…ender

minor: simplify and enhance notable traits rendering
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 this pull request may close these issues.

5 participants