Skip to content

Commit 07cd499

Browse files
committed
Elaborate on rustdoc example reason for being ignored.
1 parent 8909830 commit 07cd499

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/doc/rustdoc/src/advanced-features.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,15 @@ all type errors and name resolution errors with function bodies. Note that this
4747
work for anything outside a function body: since Rustdoc documents your types, it has to
4848
know what those types are! For example, this code will work regardless of the platform:
4949

50-
```rust,ignore (platform-specific)
50+
```rust,ignore (platform-specific,rustdoc-specific-behavior)
5151
pub fn f() {
5252
use std::os::windows::ffi::OsStrExt;
5353
}
5454
```
5555

5656
but this will not, because the unknown type is part of the function signature:
5757

58-
```rust,ignore (platform-specific)
58+
```rust,ignore (platform-specific,rustdoc-specific-behavior)
5959
pub fn f() -> std::os::windows::ffi::EncodeWide<'static> {
6060
unimplemented!()
6161
}

0 commit comments

Comments
 (0)