about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorJonathan Turner <jonathandturner@users.noreply.github.com>2016-10-24 15:41:29 -0700
committerGitHub <noreply@github.com>2016-10-24 15:41:29 -0700
commite948cf17bcd4d21e4bef2ab63b76a430967b4c29 (patch)
treec6af1288d7ec7519258e0398980307e134724ef9 /src/libstd
parent59b7ea4c59ffb36fd4c0d8e273709c87aa4b0002 (diff)
parent27dbfffc71d9816236d6467bbdf802eb0bca250d (diff)
downloadrust-e948cf17bcd4d21e4bef2ab63b76a430967b4c29.tar.gz
rust-e948cf17bcd4d21e4bef2ab63b76a430967b4c29.zip
Rollup merge of #37372 - vtduncan:pathbuf-docs-link, r=steveklabnik
Link to PathBuf from the Path docs

I got stuck trying to use `Path` when `PathBuf` was what I needed. Hopefully this makes `PathBuf` and the module docs a bit easier to find for others.

r? @steveklabnik
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/path.rs10
1 files changed, 7 insertions, 3 deletions
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
index d6a5dfe5518..a55318d3883 100644
--- a/src/libstd/path.rs
+++ b/src/libstd/path.rs
@@ -1294,14 +1294,18 @@ impl Into<OsString> for PathBuf {
 /// This type supports a number of operations for inspecting a path, including
 /// breaking the path into its components (separated by `/` or `\`, depending on
 /// the platform), extracting the file name, determining whether the path is
-/// absolute, and so on. More details about the overall approach can be found in
-/// the module documentation.
+/// absolute, and so on.
 ///
 /// This is an *unsized* type, meaning that it must always be used behind a
-/// pointer like `&` or [`Box`].
+/// pointer like `&` or [`Box`]. For an owned version of this type,
+/// see [`PathBuf`].
 ///
 /// [`str`]: ../primitive.str.html
 /// [`Box`]: ../boxed/struct.Box.html
+/// [`PathBuf`]: struct.PathBuf.html
+///
+/// More details about the overall approach can be found in
+/// the module documentation.
 ///
 /// # Examples
 ///