diff options
| author | Carol (Nichols || Goulding) <carol.nichols@gmail.com> | 2018-01-12 16:58:33 -0500 |
|---|---|---|
| committer | Carol (Nichols || Goulding) <carol.nichols@gmail.com> | 2018-01-15 13:36:52 -0500 |
| commit | c698496f8489e471024c60b3b4abc3c405ce7280 (patch) | |
| tree | 518aead07ad81cc1c77bdf777a4b2cfd9dc92296 /src/doc | |
| parent | 79a521bb9a8ace1a6663578a4c409906adde620d (diff) | |
| download | rust-c698496f8489e471024c60b3b4abc3c405ce7280.tar.gz rust-c698496f8489e471024c60b3b4abc3c405ce7280.zip | |
Reexport -> re-export in documentation section headings
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/the-doc-attribute.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index aadd72d1c90..296422744fa 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -1,7 +1,7 @@ # The `#[doc]` attribute The `#[doc]` attribute lets you control various aspects of how `rustdoc` does -its job. +its job. The most basic function of `#[doc]` is to handle the actual documentation text. That is, `///` is syntax sugar for `#[doc]`. This means that these two @@ -143,7 +143,7 @@ pub mod bar { } ``` -The documentation will generate a "Reexports" section, and say `pub use bar::Bar;`, where +The documentation will generate a "Re-exports" section, and say `pub use bar::Bar;`, where `Bar` is a link to its page. If we change the `use` line like this: @@ -184,7 +184,7 @@ mod bar { } ``` -Now we'll have a `Reexports` line, and `Bar` will not link to anywhere. +Now we'll have a `Re-exports` line, and `Bar` will not link to anywhere. ## `#[doc(hidden)]` |
