Auto merge of #38019 - sourcefrog:doc-separator, r=frewsxcv

Clearer description of std::path::MAIN_SEPARATOR.
rust-lang · Nov 28, 2016 · c7ddb89 · c7ddb89
2 parents 03bdaad + 591c134
commit c7ddb89
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
@@ -254,7 +254,9 @@ pub fn is_separator(c: char) -> bool {
     c.is_ascii() && is_sep_byte(c as u8)
 }
 
-/// The primary separator for the current platform
+/// The primary separator of path components for the current platform.
+///
+/// For example, `/` on Unix and `\` on Windows.
 #[stable(feature = "rust1", since = "1.0.0")]
 pub const MAIN_SEPARATOR: char = ::sys::path::MAIN_SEP;