diff options
| author | Hosssein <hossein.assaran@gmail.com> | 2023-12-12 20:22:41 +0330 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-12-12 20:22:41 +0330 |
| commit | a2ffff0708e7a1cb4782de378337ddfd84dd3d4b (patch) | |
| tree | 6427c4667d4d0edae82015a6c4626e962beba8b9 | |
| parent | 27d8a577138c0d319a572cd1a464c2b755e577de (diff) | |
| download | rust-a2ffff0708e7a1cb4782de378337ddfd84dd3d4b.tar.gz rust-a2ffff0708e7a1cb4782de378337ddfd84dd3d4b.zip | |
Change a typo mistake in the-doc-attribute.md
I guess that `Bar` in the section I changed should be `bar` because when I run the program it has its page under struct but bar doesn't have any page.
| -rw-r--r-- | src/doc/rustdoc/src/write-documentation/the-doc-attribute.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md b/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md index 046d018543f..669dc9358eb 100644 --- a/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md +++ b/src/doc/rustdoc/src/write-documentation/the-doc-attribute.md @@ -201,7 +201,7 @@ mod bar { # fn main() {} ``` -Here, because `bar` is not public, `Bar` wouldn't have its own page, so there's nowhere +Here, because `bar` is not public, `bar` wouldn't have its own page, so there's nowhere to link to. `rustdoc` will inline these definitions, and so we end up in the same case as the `#[doc(inline)]` above; `Bar` is in a `Structs` section, as if it were defined at the top level. If we add the `no_inline` form of the attribute: |
