mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #118883 - HosseinAssaran:patch-1, r=fmease

Browse Source 
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.
This commit is contained in:
Matthias Krüger 2023-12-13 18:03:34 +01:00 committed by GitHub
commit 666353e7ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View File

@ -201,7 +201,7 @@ mod bar {
# fn main() {} # 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 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 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: the top level. If we add the `no_inline` form of the attribute: