bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

doc: fix broken link for crate::os::linux::raw::stat

Browse source 
Fixing:

 Documenting std v0.0.0 (/checkout/library/std)
error: `self::os::linux::raw::stat` is both a struct and a function
  --> library/std/src/os/linux/fs.rs:23:19
   |
23 |     /// [`stat`]: crate::os::linux::raw::stat
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ambiguous link
   |
   = note: `-D broken-intra-doc-links` implied by `-D warnings`
help: to link to the struct, prefix with `struct@`
   |
23 |     /// [`stat`]: struct@self::os::linux::raw::stat
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
help: to link to the function, add parentheses
   |
23 |     /// [`stat`]: self::os::linux::raw::stat()
   |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error: aborting due to previous error

error: could not document `std`

Signed-off-by: Tom Eccles <tom.eccles@codethink.co.uk>
This commit is contained in:
Tom Eccles 2020-10-09 17:36:35 +01:00
parent a4a0342cf5
commit e0b033e965
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
library/std/src/os/linux/fs.rs
View file

@ -20,7 +20,7 @@ pub trait MetadataExt {
/// Unix platforms. The `os::unix::fs::MetadataExt` trait contains the
/// cross-Unix abstractions contained within the raw stat.
///
/// [`stat`]: crate::os::linux::raw::stat
/// [`stat`]: struct@crate::os::linux::raw::stat
///
/// # Examples
///