Skip to content

Commit e948cf1

Browse files
author
Jonathan Turner
authored
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
2 parents 59b7ea4 + 27dbfff commit e948cf1

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/libstd/path.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -1294,14 +1294,18 @@ impl Into<OsString> for PathBuf {
12941294
/// This type supports a number of operations for inspecting a path, including
12951295
/// breaking the path into its components (separated by `/` or `\`, depending on
12961296
/// the platform), extracting the file name, determining whether the path is
1297-
/// absolute, and so on. More details about the overall approach can be found in
1298-
/// the module documentation.
1297+
/// absolute, and so on.
12991298
///
13001299
/// This is an *unsized* type, meaning that it must always be used behind a
1301-
/// pointer like `&` or [`Box`].
1300+
/// pointer like `&` or [`Box`]. For an owned version of this type,
1301+
/// see [`PathBuf`].
13021302
///
13031303
/// [`str`]: ../primitive.str.html
13041304
/// [`Box`]: ../boxed/struct.Box.html
1305+
/// [`PathBuf`]: struct.PathBuf.html
1306+
///
1307+
/// More details about the overall approach can be found in
1308+
/// the module documentation.
13051309
///
13061310
/// # Examples
13071311
///

0 commit comments

Comments
 (0)