Skip to content

Commit 73c0ecf

Browse files
committed
---
yaml --- r: 218013 b: refs/heads/auto c: 20f421c h: refs/heads/master i: 218011: eaea0f4 v: v3
1 parent 20bf717 commit 73c0ecf

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503
88
refs/tags/release-0.3.1: 495bae036dfe5ec6ceafd3312b4dca48741e845b
99
refs/tags/release-0.4: e828ea2080499553b97dfe33b3f4d472b4562ad7
1010
refs/tags/release-0.5: 7e3bcfbf21278251ee936ad53e92e9b719702d73
11-
refs/heads/auto: 1491a8fa01f174a05e16c874fe717b99d103567d
11+
refs/heads/auto: 20f421cd522e35021049d6ec31f6b6ea3fc68c06
1212
refs/tags/release-0.6: b4ebcfa1812664df5e142f0134a5faea3918544c
1313
refs/tags/0.1: b19db808c2793fe2976759b85a355c3ad8c8b336
1414
refs/tags/0.2: 1754d02027f2924bed83b0160ee340c7f41d5ea1

branches/auto/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/auto/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 has is 0-sized and does not need construction.
41+
/// This struct 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)