From a2ffff0708e7a1cb4782de378337ddfd84dd3d4b Mon Sep 17 00:00:00 2001 From: Hosssein Date: Tue, 12 Dec 2023 20:22:41 +0330 Subject: [PATCH] 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. --- src/doc/rustdoc/src/write-documentation/the-doc-attribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 046d018543f38..669dc9358ebfc 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: