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

bors · web-flow · commit c7ddb8946bf0 · 2016-11-27T20:22:44.000-06:00
Clearer description of std::path::MAIN_SEPARATOR.
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;
 

Original file line number	Diff line number	Diff line change
`@@ -254,7 +254,9 @@ pub fn is_separator(c: char) -> bool {`
`254`	`254`	`c.is_ascii() && is_sep_byte(c as u8)`
`255`	`255`	`}`
`256`	`256`
`257`		`-/// The primary separator for the current platform`
	`257`	`+/// The primary separator of path components for the current platform.`
	`258`	`+///`
	`259`	+/// For example, `/` on Unix and `\` on Windows.
`258`	`260`	`#[stable(feature = "rust1", since = "1.0.0")]`
`259`	`261`	`pub const MAIN_SEPARATOR: char = ::sys::path::MAIN_SEP;`
`260`	`262`