diff options
| author | Nathan Goldbaum <nathan12343@gmail.com> | 2019-07-11 14:25:53 -0400 |
|---|---|---|
| committer | Nathan Goldbaum <nathan12343@gmail.com> | 2019-07-11 14:25:53 -0400 |
| commit | d4fcbb4bdb546cfdbfec54ecaf41b8aff5cc7858 (patch) | |
| tree | 5cd062a0baf11e1c25b4eddc849407c1c94012bd /src/libstd | |
| parent | 4bb6b4a5ed1cd377c5cfd97721ad12f52e63dd41 (diff) | |
| download | rust-d4fcbb4bdb546cfdbfec54ecaf41b8aff5cc7858.tar.gz rust-d4fcbb4bdb546cfdbfec54ecaf41b8aff5cc7858.zip | |
document that crate refers to the project root
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/keyword_docs.rs | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs index d18fcb4a1da..f5018485ef7 100644 --- a/src/libstd/keyword_docs.rs +++ b/src/libstd/keyword_docs.rs @@ -119,7 +119,7 @@ mod continue_keyword { } /// The `as` keyword can be used to change what the crate is referred to as in your project. If a /// crate name includes a dash, it is implicitly imported with the dashes replaced by underscores. /// -/// `crate` is also used as in conjunction with `pub` to signify that the item it's attached to +/// `crate` can also be used as in conjunction with `pub` to signify that the item it's attached to /// is public only to other members of the same crate it's in. /// /// ```rust @@ -131,6 +131,10 @@ mod continue_keyword { } /// } /// ``` /// +/// `crate` is also used to represent the absolute path of a module, where `crate` refers to the +/// root of the current crate. For instance, `crate::foo::bar` refers to the name `bar` inside the +/// module `foo`, from anywhere else in the same crate. +/// /// [Reference]: ../reference/items/extern-crates.html mod crate_keyword { } |
