File tree Expand file tree Collapse file tree 4 files changed +13
-6
lines changed Expand file tree Collapse file tree 4 files changed +13
-6
lines changed Original file line number Diff line number Diff line change 1
1
---
2
2
refs/heads/master: c044791d80ea0dc5c4b57b6030a67b69f8510239
3
- refs/heads/snap-stage3: 9748574271847c1d6e65b71eca175cfcac9361f5
3
+ refs/heads/snap-stage3: 03afbf93ed6fff191e641bc021c42631e9197ba9
4
4
refs/heads/try: b53c0f93eedcdedd4fd89bccc5a3a09d1c5cd23e
5
5
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
6
6
refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596
Original file line number Diff line number Diff line change @@ -38,6 +38,17 @@ fn add_one(x: i32) -> i32 {
38
38
}
39
39
```
40
40
41
+ There is another style of doc comment, ` //! ` , to comment containing items (e.g.
42
+ crates, modules or functions), instead of the items following it. Commonly used
43
+ inside crates root (lib.rs) or modules root (mod.rs):
44
+
45
+ ```
46
+ //! # The Rust Standard Library
47
+ //!
48
+ //! The Rust Standard Library provides the essential runtime
49
+ //! functionality for building portable Rust software.
50
+ ```
51
+
41
52
When writing doc comments, providing some examples of usage is very, very
42
53
helpful. You’ll notice we’ve used a new macro here: ` assert_eq! ` . This compares
43
54
two values, and ` panic! ` s if they’re not equal to each other. It’s very helpful
Original file line number Diff line number Diff line change @@ -38,10 +38,6 @@ const MINIMUM_CAPACITY: usize = 1; // 2 - 1
38
38
39
39
/// `VecDeque` is a growable ring buffer, which can be used as a
40
40
/// double-ended queue efficiently.
41
- ///
42
- /// The "default" usage of this type as a queue is to use `push_back` to add to the queue, and
43
- /// `pop_front` to remove from the queue. `extend` and `append` push onto the back in this manner,
44
- /// and iterating over `VecDeque` goes front to back.
45
41
#[ stable( feature = "rust1" , since = "1.0.0" ) ]
46
42
pub struct VecDeque < T > {
47
43
// tail and head are pointers into the buffer. Tail always points
Original file line number Diff line number Diff line change @@ -38,7 +38,7 @@ pub trait HashState {
38
38
/// A structure which is a factory for instances of `Hasher` which implement the
39
39
/// default trait.
40
40
///
41
- /// This struct is 0-sized and does not need construction.
41
+ /// This struct has is 0-sized and does not need construction.
42
42
pub struct DefaultState < H > ( marker:: PhantomData < H > ) ;
43
43
44
44
impl < H : Default + hash:: Hasher > HashState for DefaultState < H > {
You can’t perform that action at this time.
0 commit comments