Skip to content

Commit f1739c5

Browse files
committed
---
yaml --- r: 228115 b: refs/heads/try c: 20f421c h: refs/heads/master i: 228113: 5f7eaa6 228111: b2af620 v: v3
1 parent d9a25d9 commit f1739c5

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
@@ -1,7 +1,7 @@
11
---
22
refs/heads/master: aca2057ed5fb7af3f8905b2bc01f72fa001c35c8
33
refs/heads/snap-stage3: 1af31d4974e33027a68126fa5a5a3c2c6491824f
4-
refs/heads/try: 1491a8fa01f174a05e16c874fe717b99d103567d
4+
refs/heads/try: 20f421cd522e35021049d6ec31f6b6ea3fc68c06
55
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
66
refs/tags/release-0.2: c870d2dffb391e14efb05aa27898f1f6333a9596
77
refs/tags/release-0.3: b5f0d0f648d9a6153664837026ba1be43d3e2503

branches/try/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/try/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)