doc comment formatting

Author: DebugSteven

src/shims/unix/linux/fd.rs

@@ -103,36 +103,33 @@ pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriInterpCxExt<'mir, 'tcx> {
         }
     }
 
-    /// The epoll_wait() system call waits for events on the epoll(7)
-    /// instance referred to by the file descriptor epfd.  The buffer
-    /// pointed to by events is used to return information from the ready
+    /// The `epoll_wait()` system call waits for events on the `Epoll`
+    /// instance referred to by the file descriptor `epfd`. The buffer
+    /// pointed to by `events` is used to return information from the ready
     /// list about file descriptors in the interest list that have some
-    /// events available.  Up to maxevents are returned by epoll_wait().
-    /// The maxevents argument must be greater than zero.
+    /// events available. Up to `maxevents` are returned by `epoll_wait()`.
+    /// The `maxevents` argument must be greater than zero.
 
-    /// The timeout argument specifies the number of milliseconds that
-    /// epoll_wait() will block.  Time is measured against the
+    /// The `timeout` argument specifies the number of milliseconds that
+    /// `epoll_wait()` will block. Time is measured against the
     /// CLOCK_MONOTONIC clock.
 
-    /// A call to epoll_wait() will block until either:
-
+    /// A call to `epoll_wait()` will block until either:
     /// • a file descriptor delivers an event;
-
     /// • the call is interrupted by a signal handler; or
-
     /// • the timeout expires.
 
     /// Note that the timeout interval will be rounded up to the system
     /// clock granularity, and kernel scheduling delays mean that the
-    /// blocking interval may overrun by a small amount.  Specifying a
-    /// timeout of -1 causes epoll_wait() to block indefinitely, while
-    /// specifying a timeout equal to zero cause epoll_wait() to return
+    /// blocking interval may overrun by a small amount. Specifying a
+    /// timeout of -1 causes `epoll_wait()` to block indefinitely, while
+    /// specifying a timeout equal to zero cause `epoll_wait()` to return
     /// immediately, even if no events are available.
     ///
-    /// On success, epoll_wait() returns the number of file descriptors
+    /// On success, `epoll_wait()` returns the number of file descriptors
     /// ready for the requested I/O, or zero if no file descriptor became
-    /// ready during the requested timeout milliseconds.  On failure,
-    /// epoll_wait() returns -1 and errno is set to indicate the error.
+    /// ready during the requested timeout milliseconds. On failure,
+    /// `epoll_wait()` returns -1 and errno is set to indicate the error.
     ///
     /// <https://man7.org/linux/man-pages/man2/epoll_wait.2.html>
     fn epoll_wait(