From: Miguel Ojeda <ojeda@kernel.org>
Date: Mon, 24 Mar 2025 21:03:55 +0000 (+0100)
Subject: rust: platform: fix docs related to missing Markdown code spans
X-Git-Tag: v6.16-rc1~45^2~20
X-Git-Url: https://git.kernel.dk/?a=commitdiff_plain;h=9f047636831a61ce0840929555245dd17695206a;p=linux-block.git

rust: platform: fix docs related to missing Markdown code spans

Convert `TODO` from documentation to a normal comment, and put code in
block.

This was found using the Clippy `doc_markdown` lint, which we may want
to enable.

Fixes: 683a63befc73 ("rust: platform: add basic platform device / driver abstractions")
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20250324210359.1199574-9-ojeda@kernel.org
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---

diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs
index fd4a494f30e8..a02ae5b25b74 100644
--- a/rust/kernel/platform.rs
+++ b/rust/kernel/platform.rs
@@ -151,10 +151,11 @@ macro_rules! module_platform_driver {
 ///```
 pub trait Driver: Send {
     /// The type holding driver private data about each device id supported by the driver.
-    ///
-    /// TODO: Use associated_type_defaults once stabilized:
-    ///
-    /// type IdInfo: 'static = ();
+    // TODO: Use associated_type_defaults once stabilized:
+    //
+    // ```
+    // type IdInfo: 'static = ();
+    // ```
     type IdInfo: 'static;
 
     /// The table of OF device ids supported by the driver.