minor wording tweak to slice::{as_ptr, as_mut_ptr} #40603

QuietMisdreavus · 2017-03-17T15:53:49Z

Per #37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the slice itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the collection that could cause the buffer to be reallocated.

r? @steveklabnik

GuillaumeGomez · 2017-03-17T17:20:03Z

src/libcollections/slice.rs

@@ -437,8 +437,8 @@ impl<T> [T] {
    /// The caller must ensure that the slice outlives the pointer this
    /// function returns, or else it will end up pointing to garbage.
    ///
-    /// Modifying the slice may cause its buffer to be reallocated, which
-    /// would also make any pointers to it invalid.
+    /// Modifying the container this slice references may cause its buffer


I'd prefer: "Modifying the container referenced by this slice may.."

GuillaumeGomez · 2017-03-17T17:20:13Z

src/libcollections/slice.rs

@@ -463,8 +463,8 @@ impl<T> [T] {
    /// The caller must ensure that the slice outlives the pointer this
    /// function returns, or else it will end up pointing to garbage.
    ///
-    /// Modifying the slice may cause its buffer to be reallocated, which
-    /// would also make any pointers to it invalid.
+    /// Modifying the container this slice references may cause its buffer


GuillaumeGomez · 2017-03-17T17:25:56Z

Thanks!

@bors: r+ rollup

bors · 2017-03-17T17:25:57Z

📌 Commit 963d4df has been approved by GuillaumeGomez

steveklabnik · 2017-03-17T17:26:41Z

src/libcollections/slice.rs

@@ -437,8 +437,8 @@ impl<T> [T] {
    /// The caller must ensure that the slice outlives the pointer this
    /// function returns, or else it will end up pointing to garbage.
    ///
-    /// Modifying the slice may cause its buffer to be reallocated, which
-    /// would also make any pointers to it invalid.
+    /// Modifying the container this slice references may cause its buffer


Hm, I wonder if "container" is the right word here, is an array a "container"? we don't really use it as a standard term, idk

Yeah, I was hoping to have it be a generalized term, even though it's not "standard" per se. In this context, I'd call an array a "container", given that it's what holds the ownership of its items. Could go either way, what with the heap-allocated variable-length things being in "libcollections". :/

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

Rollup of 22 pull requests - Successful merges: #40241, #40346, #40348, #40377, #40398, #40409, #40441, #40445, #40509, #40521, #40523, #40532, #40538, #40564, #40581, #40583, #40588, #40589, #40590, #40603, #40611, #40621 - Failed merges: #40501, #40541

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

@steveklabnik

…uillaumeGomez minor wording tweak to slice::{as_ptr, as_mut_ptr} Per rust-lang#37334, the slice-as-pointer methods mentioned that "modifying the slice may cause its buffer to be reallocated", when in fact modifying the *slice* itself would cause no such change. (It is a borrow, after all!) This is a tweak to the wording of that line to stress it's the *collection* that could cause the buffer to be reallocated. r? @steveklabnik

Rollup of 13 pull requests - Successful merges: #40441, #40445, #40562, #40564, #40583, #40588, #40589, #40590, #40603, #40611, #40621, #40646, #40648 - Failed merges:

rust-highfive assigned steveklabnik Mar 17, 2017

QuietMisdreavus mentioned this pull request Mar 17, 2017

Confusing wording in docs for slice::as_ptr/as_mut_ptr #37334

Closed

GuillaumeGomez requested changes Mar 17, 2017

View reviewed changes

minor wording tweak to slice::{as_ptr, as_mut_ptr}

963d4df

QuietMisdreavus force-pushed the slice-ptr-docs branch from bc4e25e to 963d4df Compare March 17, 2017 17:24

GuillaumeGomez approved these changes Mar 17, 2017

View reviewed changes

steveklabnik reviewed Mar 17, 2017

View reviewed changes

frewsxcv mentioned this pull request Mar 17, 2017

Rollup of 15 pull requests #40615

Closed

frewsxcv mentioned this pull request Mar 17, 2017

Rollup of 16 pull requests #40616

Closed

frewsxcv mentioned this pull request Mar 17, 2017

Rollup of 12 pull requests #40618

Closed

frewsxcv mentioned this pull request Mar 18, 2017

Rollup of 8 pull requests #40626

Closed

frewsxcv mentioned this pull request Mar 18, 2017

Rollup of 10 pull requests #40629

Closed

frewsxcv mentioned this pull request Mar 18, 2017

Rollup of 8 pull requests #40633

Closed

frewsxcv mentioned this pull request Mar 18, 2017

Rollup of 9 pull requests #40635

Closed

frewsxcv mentioned this pull request Mar 18, 2017

Rollup of 20 pull requests #40643

Closed

arielb1 mentioned this pull request Mar 18, 2017

Rollup of 22 pull requests #40644

Closed

arielb1 mentioned this pull request Mar 19, 2017

Rollup of 21 pull requests #40645

Closed

frewsxcv mentioned this pull request Mar 19, 2017

Rollup of 8 pull requests #40647

Closed

frewsxcv mentioned this pull request Mar 19, 2017

Rollup of 13 pull requests #40651

Merged

bors added a commit that referenced this pull request Mar 19, 2017

Auto merge of #40651 - frewsxcv:rollup, r=frewsxcv

38c53f3

Rollup of 13 pull requests - Successful merges: #40441, #40445, #40562, #40564, #40583, #40588, #40589, #40590, #40603, #40611, #40621, #40646, #40648 - Failed merges:

bors merged commit 963d4df into rust-lang:master Mar 19, 2017

QuietMisdreavus deleted the slice-ptr-docs branch August 16, 2017 00:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

minor wording tweak to slice::{as_ptr, as_mut_ptr} #40603

minor wording tweak to slice::{as_ptr, as_mut_ptr} #40603

QuietMisdreavus commented Mar 17, 2017

GuillaumeGomez Mar 17, 2017

GuillaumeGomez Mar 17, 2017

GuillaumeGomez commented Mar 17, 2017

bors commented Mar 17, 2017

steveklabnik Mar 17, 2017

QuietMisdreavus Mar 17, 2017

minor wording tweak to slice::{as_ptr, as_mut_ptr} #40603

minor wording tweak to slice::{as_ptr, as_mut_ptr} #40603

Conversation

QuietMisdreavus commented Mar 17, 2017

GuillaumeGomez Mar 17, 2017

Choose a reason for hiding this comment

GuillaumeGomez Mar 17, 2017

Choose a reason for hiding this comment

GuillaumeGomez commented Mar 17, 2017

bors commented Mar 17, 2017

steveklabnik Mar 17, 2017

Choose a reason for hiding this comment

QuietMisdreavus Mar 17, 2017

Choose a reason for hiding this comment