Skip to content

Commit 04f7cb7

Browse files
committed
---
yaml --- r: 219868 b: refs/heads/snap-stage3 c: 03afbf9 h: refs/heads/master v: v3
1 parent 9e9d882 commit 04f7cb7

File tree

4 files changed

+13
-6
lines changed

4 files changed

+13
-6
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
refs/heads/master: c044791d80ea0dc5c4b57b6030a67b69f8510239
3-
refs/heads/snap-stage3: 9748574271847c1d6e65b71eca175cfcac9361f5
3+
refs/heads/snap-stage3: 03afbf93ed6fff191e641bc021c42631e9197ba9
44
refs/heads/try: b53c0f93eedcdedd4fd89bccc5a3a09d1c5cd23e
55
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
66
refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596

branches/snap-stage3/src/doc/trpl/comments.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ fn add_one(x: i32) -> i32 {
3838
}
3939
```
4040

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+
4152
When writing doc comments, providing some examples of usage is very, very
4253
helpful. You’ll notice we’ve used a new macro here: `assert_eq!`. This compares
4354
two values, and `panic!`s if they’re not equal to each other. It’s very helpful

branches/snap-stage3/src/libcollections/vec_deque.rs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ const MINIMUM_CAPACITY: usize = 1; // 2 - 1
3838

3939
/// `VecDeque` is a growable ring buffer, which can be used as a
4040
/// 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.
4541
#[stable(feature = "rust1", since = "1.0.0")]
4642
pub struct VecDeque<T> {
4743
// tail and head are pointers into the buffer. Tail always points

branches/snap-stage3/src/libstd/collections/hash/state.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ pub trait HashState {
3838
/// A structure which is a factory for instances of `Hasher` which implement the
3939
/// default trait.
4040
///
41-
/// This struct is 0-sized and does not need construction.
41+
/// This struct has is 0-sized and does not need construction.
4242
pub struct DefaultState<H>(marker::PhantomData<H>);
4343

4444
impl<H: Default + hash::Hasher> HashState for DefaultState<H> {

0 commit comments

Comments
 (0)