about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2016-11-27 20:22:44 -0600
committerGitHub <noreply@github.com>2016-11-27 20:22:44 -0600
commitc7ddb8946bf041d89ba109ec8dd754492de78606 (patch)
tree5d0abf1263601460667fca03c1a8e55bac847659 /src/libstd
parent03bdaade2a0c39118a5be927c667776a5de0d681 (diff)
parent591c1344560c9e231738a0218770bc14c96f29ae (diff)
downloadrust-c7ddb8946bf041d89ba109ec8dd754492de78606.tar.gz
rust-c7ddb8946bf041d89ba109ec8dd754492de78606.zip
Auto merge of #38019 - sourcefrog:doc-separator, r=frewsxcv
Clearer description of std::path::MAIN_SEPARATOR.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/path.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
index 95c8af66425..d215f368d1e 100644
--- 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;