virtio-blk: add missing method doc in tests

epilys · epilys · commit 7035c0af7787 · 2025-01-10T11:37:46.000+02:00
Add missing doc comment in #[cfg(test)] Request::new() method to silence
the `missing_docs` rustc lint.

    error: missing documentation for an associated function
       --&gt; virtio-blk/src/request.rs:278:9
        |
    278 | /         pub fn new(
    279 | |             request_type: RequestType,
    280 | |             data: Vec&lt;(GuestAddress, u32)&gt;,
    281 | |             sector: u64,
    282 | |             status_addr: GuestAddress,
    283 | |         ) -&gt; Self {
        | |_________________^
        |
    note: the lint level is defined here
       --&gt; virtio-blk/src/lib.rs:8:9
        |
    8   | #![deny(missing_docs)]
        |         ^^^^^^^^^^^^

Signed-off-by: Manos Pitsidianakis &lt;manos.pitsidianakis@linaro.org&gt;
diff --git a/virtio-blk/src/request.rs b/virtio-blk/src/request.rs
@@ -275,6 +275,7 @@ mod tests {
     }
 
     impl Request {
+        /// Manually create mock `Request` instances.
         pub fn new(
             request_type: RequestType,
             data: Vec<(GuestAddress, u32)>,

Original file line number	Diff line number	Diff line change
`@@ -275,6 +275,7 @@ mod tests {`
`275`	`275`	`}`
`276`	`276`
`277`	`277`	`impl Request {`
	`278`	+ /// Manually create mock `Request` instances.
`278`	`279`	`pub fn new(`
`279`	`280`	`request_type: RequestType,`
`280`	`281`	`data: Vec<(GuestAddress, u32)>,`