Elaborate on rustdoc example reason for being ignored.

This commit is contained in:
Eric Huss 2021-01-25 18:15:34 -08:00
parent bb22eaf39e
commit dc7746f334

View file

@ -47,7 +47,7 @@ all type errors and name resolution errors with function bodies. Note that this
work for anything outside a function body: since Rustdoc documents your types, it has to
know what those types are! For example, this code will work regardless of the platform:
```rust,ignore (platform-specific)
```rust,ignore (platform-specific,rustdoc-specific-behavior)
pub fn f() {
use std::os::windows::ffi::OsStrExt;
}
@ -55,7 +55,7 @@ pub fn f() {
but this will not, because the unknown type is part of the function signature:
```rust,ignore (platform-specific)
```rust,ignore (platform-specific,rustdoc-specific-behavior)
pub fn f() -> std::os::windows::ffi::EncodeWide<'static> {
unimplemented!()
}