docs: correct a doc comment (#2317)

SteveLauC · web-flow · commit a97cc878da91 · 2024-02-25T23:34:54.000Z
diff --git a/src/dir.rs b/src/dir.rs
@@ -59,7 +59,7 @@ impl Dir {
         Dir::from_fd(fd.into_raw_fd())
     }
 
-    /// Converts from a file descriptor, closing it on success or failure.
+    /// Converts from a file descriptor, closing it on failure.
     #[doc(alias("fdopendir"))]
     pub fn from_fd(fd: RawFd) -> Result<Self> {
         let d = ptr::NonNull::new(unsafe { libc::fdopendir(fd) }).ok_or_else(

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ impl Dir {`
`59`	`59`	`Dir::from_fd(fd.into_raw_fd())`
`60`	`60`	`}`
`61`	`61`
`62`		`- /// Converts from a file descriptor, closing it on success or failure.`
	`62`	`+ /// Converts from a file descriptor, closing it on failure.`
`63`	`63`	`#[doc(alias("fdopendir"))]`
`64`	`64`	`pub fn from_fd(fd: RawFd) -> Result<Self> {`
`65`	`65`	`let d = ptr::NonNull::new(unsafe { libc::fdopendir(fd) }).ok_or_else(`