Document drop more. #42159

Havvy · 2017-05-22T23:03:49Z

Adds two examples to Drop and describes the recursive drop on types that contain fields.

rust-highfive · 2017-05-22T23:04:01Z

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

Havvy · 2017-05-22T23:27:38Z

r? @steveklabnik

(Does this work?)

birkenfeld · 2017-05-23T06:29:49Z

src/libcore/ops.rs

@@ -153,6 +153,14 @@ use marker::Unsize;
 /// The `Drop` trait is used to run some code when a value goes out of scope.
 /// This is sometimes called a 'destructor'.
 ///
+/// When a value goes out of scope, if it implements this trait, it will have


This is a bit repetitive w.r.t "when a value goes out of scope".

That's fine, as the first line is a summary, and this is the full explanation.

birkenfeld · 2017-05-23T06:30:23Z

src/libcore/ops.rs

+///
+/// Because of the recursive dropping, even for types that do not implement
+/// this trait, you do not need to implement this trait unless your type
+/// needs its own destructor logic.


"even for types that do not implement this trait, you do not need to implement this trait"

doesn't parse to me :)

This is what happens when you stare at the screen for half an hour wondering what to write.

birkenfeld · 2017-05-23T06:31:11Z

src/libcore/ops.rs

@@ -171,6 +179,44 @@ use marker::Unsize;
 ///     let _x = HasDrop;
 /// }
 /// ```
+///
+/// Showing the recursive nature of `Drop`. When `outer` goes out of scope, the


First sentence is incomplete?

Only as much as the first sentence to the previous example which says "A trivial implementation of Drop".

Yeah; I think this is fine, though personally, I tend to use fragments like this for the short ones, and since there's more here, I'd probably make it a full sentence. NBD

birkenfeld · 2017-05-23T06:32:10Z

src/libcore/ops.rs

+///
+/// Showing the recursive nature of `Drop`. When `outer` goes out of scope, the
+/// `drop` method will be called for `Outer` and then the `drop` method for
+/// `Inner` will be called. Therefore `main` prints `Dropping Outer!` and then


repetitive wording "the drop method will be called for Outer and then the drop method for Inner will be called."
Why not "the drop method will be called first for Outer, then for Inner"

birkenfeld · 2017-05-23T06:32:18Z

src/libcore/ops.rs

+/// }
+/// ```
+///
+/// Because variables are dropped in the reverse order they are declared,


Is "declared" the right term here?

steveklabnik · 2017-05-23T14:06:54Z

src/libcore/ops.rs

@@ -153,6 +153,14 @@ use marker::Unsize;
 /// The `Drop` trait is used to run some code when a value goes out of scope.
 /// This is sometimes called a 'destructor'.
 ///
+/// When a value goes out of scope, if it implements this trait, it will have


That's fine, as the first line is a summary, and this is the full explanation.

steveklabnik · 2017-05-23T14:07:46Z

src/libcore/ops.rs

@@ -171,6 +179,44 @@ use marker::Unsize;
 ///     let _x = HasDrop;
 /// }
 /// ```
+///
+/// Showing the recursive nature of `Drop`. When `outer` goes out of scope, the


Yeah; I think this is fine, though personally, I tend to use fragments like this for the short ones, and since there's more here, I'd probably make it a full sentence. NBD

steveklabnik · 2017-05-23T14:07:57Z

src/libcore/ops.rs

+/// }
+/// ```
+///
+/// Because variables are dropped in the reverse order they are declared,


steveklabnik · 2017-05-23T14:08:14Z

@bors: r+ rollup

thanks so much!

bors · 2017-05-23T14:08:15Z

📌 Commit b41b294 has been approved by steveklabnik

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Rollup of 16 pull requests - Successful merges: #41700, #41980, #42052, #42071, #42120, #42134, #42141, #42142, #42149, #42150, #42159, #42177, #42186, #42191, #42195, #42198 - Failed merges:

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Rollup of 15 pull requests - Successful merges: #41980, #42071, #42120, #42134, #42141, #42142, #42149, #42150, #42159, #42177, #42186, #42191, #42195, #42198, #42211 - Failed merges:

Havvy added 3 commits May 22, 2017 15:06

Add example of recursive drop to Drop trait.

14b767d

Add example of variable declaration drop order to Drop trait.

ca909c8

Add description of how values are dropped to Drop trait.

d7927ff

rust-highfive assigned brson May 22, 2017

rust-highfive assigned steveklabnik and unassigned brson May 22, 2017

Fix trailing whitespace.

5f4b0ff

birkenfeld reviewed May 23, 2017

View reviewed changes

Suggested changes by birkenfeld

b41b294

steveklabnik approved these changes May 23, 2017

View reviewed changes

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 23, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

20a5a5d

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 23, 2017

Rollup of 7 pull requests #42178

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

5b88bb8

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

frewsxcv mentioned this pull request May 24, 2017

Rollup of 8 pull requests #42184

Closed

frewsxcv added a commit to frewsxcv/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

fdceb4e

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

frewsxcv mentioned this pull request May 24, 2017

Rollup of 8 pull requests #42185

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

caf881a

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 24, 2017

Rollup of 14 pull requests #42193

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

54514a8

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 24, 2017

Rollup of 17 pull requests #42199

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 24, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

c2866d9

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 24, 2017

Rollup of 16 pull requests #42203

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 25, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

e02d895

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 25, 2017

Rollup of 16 pull requests #42209

Closed

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request May 25, 2017

Rollup merge of rust-lang#42159 - Havvy:doc-drop, r=steveklabnik

ca0860d

Document drop more. Adds two examples to Drop and describes the recursive drop on types that contain fields.

Mark-Simulacrum mentioned this pull request May 25, 2017

Rollup of 15 pull requests #42212

Merged

bors merged commit b41b294 into rust-lang:master May 25, 2017

Havvy deleted the doc-drop branch May 25, 2017 05:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document drop more. #42159

Document drop more. #42159

Havvy commented May 22, 2017

rust-highfive commented May 22, 2017

Havvy commented May 22, 2017

birkenfeld May 23, 2017

steveklabnik May 23, 2017

birkenfeld May 23, 2017

Havvy May 23, 2017

birkenfeld May 23, 2017

Havvy May 23, 2017

steveklabnik May 23, 2017

birkenfeld May 23, 2017

Havvy May 23, 2017

birkenfeld May 23, 2017

steveklabnik May 23, 2017

steveklabnik May 23, 2017

steveklabnik May 23, 2017

steveklabnik May 23, 2017

steveklabnik commented May 23, 2017

bors commented May 23, 2017

Document drop more. #42159

Document drop more. #42159

Conversation

Havvy commented May 22, 2017

rust-highfive commented May 22, 2017

Havvy commented May 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steveklabnik commented May 23, 2017

bors commented May 23, 2017