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.

Sign up for GitHub

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

Jump to bottom

Make some docs nicer wrt pointer offsets #100821

Merged
merged 2 commits into from
Aug 21, 2022
Merged

Make some docs nicer wrt pointer offsets #100821

merged 2 commits into from
Aug 21, 2022

Conversation

WaffleLapkin
Copy link
Member

This PR replaces pointer::offset with pointer::add and similarly .cast().wrapping_add().cast() with .wrapping_byte_add() in docs.

r? @scottmcm

split off from #100746

@rustbot rustbot added the T-libs Relevant to the library team, which will review and decide on the PR/issue. label Aug 20, 2022
@rustbot
Copy link
Collaborator

rustbot commented Aug 20, 2022

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 20, 2022
scottmcm
scottmcm reviewed Aug 21, 2022
View reviewed changes
library/core/src/intrinsics.rs Outdated
@@ -2211,7 +2211,7 @@ pub(crate) fn is_nonoverlapping<T>(src: *const T, dst: *const T, count: usize) -
/// unsafe {
/// // The call to offset is always safe because `Vec` will never
Copy link
Member

Choose a reason for hiding this comment

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

nit:

Suggested change
/// // The call to offset is always safe because `Vec` will never
/// // The call to add is always safe because `Vec` will never

@scottmcm
Copy link
Member

Thanks for splitting these out :)

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 21, 2022
@scottmcm
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Aug 21, 2022

📌 Commit b2625e2 has been approved by scottmcm

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 21, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#100821 - WaffleLapkin:ptr_add_docs, r=scottmcm
e88e934 
Make some docs nicer wrt pointer offsets

This PR replaces `pointer::offset` with `pointer::add` and similarly `.cast().wrapping_add().cast()` with `.wrapping_byte_add()` **in docs**.

r? `@scottmcm`

_split off from #100746_
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 21, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#100821 - WaffleLapkin:ptr_add_docs, r=scottmcm
06614b4 
Make some docs nicer wrt pointer offsets

This PR replaces `pointer::offset` with `pointer::add` and similarly `.cast().wrapping_add().cast()` with `.wrapping_byte_add()` **in docs**.

r? ``@scottmcm``

_split off from #100746_
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 21, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#100821 - WaffleLapkin:ptr_add_docs, r=scottmcm
d438061 
Make some docs nicer wrt pointer offsets

This PR replaces `pointer::offset` with `pointer::add` and similarly `.cast().wrapping_add().cast()` with `.wrapping_byte_add()` **in docs**.

r? ```@scottmcm```

_split off from #100746_
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 21, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#100821 - WaffleLapkin:ptr_add_docs, r=scottmcm
9011912 
Make some docs nicer wrt pointer offsets

This PR replaces `pointer::offset` with `pointer::add` and similarly `.cast().wrapping_add().cast()` with `.wrapping_byte_add()` **in docs**.

r? ````@scottmcm````

_split off from #100746_
@matthiaskrgr matthiaskrgr mentioned this pull request Aug 21, 2022
Closed
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 21, 2022
@matthiaskrgr
Rollup merge of rust-lang#100821 - WaffleLapkin:ptr_add_docs, r=scottmcm
2ddbfce 
Make some docs nicer wrt pointer offsets

This PR replaces `pointer::offset` with `pointer::add` and similarly `.cast().wrapping_add().cast()` with `.wrapping_byte_add()` **in docs**.

r? `````@scottmcm`````

_split off from #100746_
This was referenced Aug 21, 2022
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Aug 21, 2022
@bors
Auto merge of rust-lang#100847 - matthiaskrgr:rollup-0ga531s, r=matth…
c0941df 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#100556 (Clamp Function for f32 and f64)
 - rust-lang#100663 (Make slice::reverse const)
 - rust-lang#100697 ( Minor syntax and formatting update to doc comment on `find_vtable_types_for_unsizing`)
 - rust-lang#100760 (update test for LLVM change)
 - rust-lang#100761 (some general mir typeck cleanup)
 - rust-lang#100775 (rustdoc: Merge source code pages HTML elements together v2)
 - rust-lang#100813 (Add `/build-rust-analyzer/` to .gitignore)
 - rust-lang#100821 (Make some docs nicer wrt pointer offsets)
 - rust-lang#100822 (Replace most uses of `pointer::offset` with `add` and `sub`)
 - rust-lang#100839 (Make doc for stdin field of process consistent)
 - rust-lang#100842 (Add diagnostics lints to `rustc_transmute` module (zero diags))

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit fd403f5 into rust-lang:master Aug 21, 2022
@rustbot rustbot added this to the 1.65.0 milestone Aug 21, 2022
@WaffleLapkin WaffleLapkin deleted the ptr_add_docs branch September 4, 2022 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@scottmcm scottmcm scottmcm left review comments

Assignees

@scottmcm scottmcm

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.65.0
Development

Successfully merging this pull request may close these issues.
5 participants
@WaffleLapkin @rustbot @scottmcm @bors @rust-highfive