about summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Huss <eric@huss.org>2021-01-25 18:15:34 -0800
committerEric Huss <eric@huss.org>2021-02-04 09:01:50 -0800
commitdc7746f3343429924531daa6d692eba94b414e55 (patch)
treee1e2e2add21fc659d1cae2f0fc827c88b06dbae0
parentbb22eaf39e6e0a904a8f19a2a659620c12f03a24 (diff)
downloadrust-dc7746f3343429924531daa6d692eba94b414e55.tar.gz
rust-dc7746f3343429924531daa6d692eba94b414e55.zip
Elaborate on rustdoc example reason for being ignored.
-rw-r--r--src/doc/rustdoc/src/advanced-features.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/advanced-features.md b/src/doc/rustdoc/src/advanced-features.md
index 990a6b00d18..abdc2e4025d 100644
--- a/src/doc/rustdoc/src/advanced-features.md
+++ b/src/doc/rustdoc/src/advanced-features.md
@@ -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!()
 }