Add simple docs example for struct Cell #43423

ghost · 2017-07-23T12:19:40Z

No description provided.

rust-highfive · 2017-07-23T12:19:51Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @BurntSushi (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

BurntSushi · 2017-07-24T11:32:56Z

src/libcore/cell.rs

+/// // WORKS, special_field is mutable because it is Cell
+/// immutable.special_field.set(new_value);
+/// assert_eq!(immutable.special_field.get(), new_value);
+/// ```


I don't think this follows the prevailing style in the docs. For example, I think it is at least missing an Examples header. I'd also like to see some prose describing what the example is trying to show.

cc @steveklabnik

I've added some prose and example section.
BTW: I'd see reference to this blog post:
https://ricardomartins.cc/2016/06/08/interior-mutability
in the docs. but perhaps adding links to blog post is not the way of doing docs. :)

Maybe it's just me but I was reading this https://doc.rust-lang.org/std/cell/ a few times and still didn't know what Cell is all about then read the blog post once to get the concept easily.. .

steveklabnik

A few nits, and the build is failing.

steveklabnik · 2017-07-24T15:26:03Z

src/libcore/cell.rs

@@ -187,6 +187,34 @@ use ops::{Deref, DerefMut, CoerceUnsized};
 use ptr;

 /// A mutable memory location.
+/// 
+/// # Example


this should be Examples even though there's only one, for consistency

steveklabnik · 2017-07-24T15:26:17Z

src/libcore/cell.rs

+/// 
+/// # Example
+/// 
+/// Here you can see how using `Cell<T>` allows to use muttable field inside


mutable, not muttable

steveklabnik · 2017-07-24T15:26:25Z

src/libcore/cell.rs

+/// # Example
+/// 
+/// Here you can see how using `Cell<T>` allows to use muttable field inside
+/// immutable struct (which is also called "interior mutability").


single quotes here please!

ghost · 2017-07-24T17:32:27Z

@steveklabnik done

steveklabnik

sorry! just some last-minute white space changes; I must have missed them before?

This is good to go once that's fixed; I want to make sure this is consistent with the rest of the standard library.

steveklabnik · 2017-07-24T18:18:49Z

src/libcore/cell.rs

@@ -187,6 +187,29 @@ use ops::{Deref, DerefMut, CoerceUnsized};
 use ptr;

 /// A mutable memory location.
+/// # Examples


can you put a /// above and below this line

like here? 8286075

Because i put it at first place and it was the cause of CI failure (something related to tidy check)

yes. you had trailing whitespace; that was the only issue, not the ///s. In other words

"///"

not

"/// "

make sense?

steveklabnik · 2017-07-24T18:18:54Z

src/libcore/cell.rs

+/// # Examples
+/// Here you can see how using `Cell<T>` allows to use mutable field inside
+/// immutable struct (which is also called 'interior mutability').
+/// ```


also above this line

steveklabnik · 2017-07-24T18:19:08Z

src/libcore/cell.rs

+/// let new_value = 100;
+/// // ERROR, because my_struct is immutable
+/// // immutable.regular_field = new_value;
+/// // WORKS, although `my_struct` is immutable, field `special_field` is mutable because it is Cell


also one above this line

steveklabnik · 2017-07-24T18:19:13Z

src/libcore/cell.rs

+/// };
+///
+/// let new_value = 100;
+/// // ERROR, because my_struct is immutable


also one above this line

steveklabnik · 2017-07-24T21:31:52Z

src/libcore/cell.rs

+///     // immutable.regular_field = new_value;
+///
+///     // WORKS, although `my_struct` is immutable, field `special_field` is mutable because it is Cell
+///     immutable.special_field.set(new_value);


main isn't the issue. here's the error

01:00:45] error[E0425]: cannot find value `immutable` in this scope [01:00:45] --> <anon>:22:1 [01:00:45] | [01:00:45] 22 | immutable.special_field.set(new_value); [01:00:45] | ^^^^^^^^^ not found in this scope [01:00:45] [01:00:45] error[E0425]: cannot find value `immutable` in this scope [01:00:45] --> <anon>:23:12 [01:00:45] | [01:00:45] 23 | assert_eq!(immutable.special_field.get(), new_value); [01:00:45] | ^^^^^^^^^ not found in this scope [01:00:45]

on this line, you use something called "immutable" but you never defined it; it's called my_struct above

You're right.. maybe i should go to sleep for today :)

ghost · 2017-07-25T18:09:01Z

r? @steveklabnik is it ok, what do you think?

carols10cents · 2017-07-31T12:38:12Z

friendly ping for review @steveklabnik !

carols10cents · 2017-07-31T12:39:36Z

r? @steveklabnik

steveklabnik · 2017-07-31T15:26:53Z

@bors: r+ rollup

@xliiv thanks a ton! Sorry for the delays again ☹️

bors · 2017-07-31T15:26:55Z

📌 Commit d429a4e has been approved by steveklabnik

ghost · 2017-07-31T15:56:25Z

@steveklabnik you are welcome :)
I didn't know that contributing to rust is so easy (at least contributing to docs)

Add simple docs example for struct Cell

Rollup of 6 pull requests - Successful merges: #43389, #43423, #43581, #43585, #43597, #43598 - Failed merges:

rust-highfive assigned BurntSushi Jul 23, 2017

Add simple docs example for struct Cell

236b748

BurntSushi reviewed Jul 24, 2017

View reviewed changes

BurntSushi added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jul 24, 2017

add prose

bb65d32

steveklabnik suggested changes Jul 24, 2017

View reviewed changes

Tymoteusz Jankowski added 2 commits July 24, 2017 18:01

review fixes

3c53595

ci fix?

8286075

steveklabnik approved these changes Jul 24, 2017

View reviewed changes

steveklabnik suggested changes Jul 24, 2017

View reviewed changes

empty lines

beb072a

steveklabnik reviewed Jul 24, 2017

View reviewed changes

s/immutable/my_struct

d429a4e

carols10cents added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 31, 2017

rust-highfive assigned steveklabnik and unassigned BurntSushi Jul 31, 2017

steveklabnik approved these changes Jul 31, 2017

View reviewed changes

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Aug 2, 2017

Rollup merge of rust-lang#43423 - xliiv:cell-example, r=steveklabnik

2d9893f

Add simple docs example for struct Cell

frewsxcv mentioned this pull request Aug 2, 2017

Rollup of 6 pull requests #43603

Merged

bors added a commit that referenced this pull request Aug 2, 2017

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

4f3062c

Rollup of 6 pull requests - Successful merges: #43389, #43423, #43581, #43585, #43597, #43598 - Failed merges:

bors merged commit d429a4e into rust-lang:master Aug 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add simple docs example for struct Cell #43423

Add simple docs example for struct Cell #43423

ghost commented Jul 23, 2017

rust-highfive commented Jul 23, 2017

BurntSushi Jul 24, 2017

ghost Jul 24, 2017 •

edited by ghost

Loading

steveklabnik left a comment

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

ghost commented Jul 24, 2017

steveklabnik left a comment

steveklabnik Jul 24, 2017

ghost Jul 24, 2017

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

steveklabnik Jul 24, 2017

ghost Jul 24, 2017

ghost commented Jul 25, 2017 •

edited by ghost

Loading

carols10cents commented Jul 31, 2017 •

edited

Loading

carols10cents commented Jul 31, 2017

steveklabnik commented Jul 31, 2017

bors commented Jul 31, 2017

ghost commented Jul 31, 2017 •

edited by ghost

Loading

Add simple docs example for struct Cell #43423

Add simple docs example for struct Cell #43423

Conversation

ghost commented Jul 23, 2017

rust-highfive commented Jul 23, 2017

Choose a reason for hiding this comment

ghost Jul 24, 2017 • edited by ghost Loading

Choose a reason for hiding this comment

steveklabnik left a 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

ghost commented Jul 24, 2017

steveklabnik left a 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

ghost commented Jul 25, 2017 • edited by ghost Loading

carols10cents commented Jul 31, 2017 • edited Loading

carols10cents commented Jul 31, 2017

steveklabnik commented Jul 31, 2017

bors commented Jul 31, 2017

ghost commented Jul 31, 2017 • edited by ghost Loading

ghost Jul 24, 2017 •

edited by ghost

Loading

ghost commented Jul 25, 2017 •

edited by ghost

Loading

carols10cents commented Jul 31, 2017 •

edited

Loading

ghost commented Jul 31, 2017 •

edited by ghost

Loading