Skip to content

Commit f264495

Browse files
committed
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: 683a63b ("rust: platform: add basic platform device / driver abstractions") Reviewed-by: Benno Lossin <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Miguel Ojeda <[email protected]>
1 parent fffcd7c commit f264495

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

rust/kernel/platform.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,11 @@ macro_rules! module_platform_driver {
151151
///```
152152
pub trait Driver: Send {
153153
/// The type holding driver private data about each device id supported by the driver.
154-
///
155-
/// TODO: Use associated_type_defaults once stabilized:
156-
///
157-
/// type IdInfo: 'static = ();
154+
// TODO: Use associated_type_defaults once stabilized:
155+
//
156+
// ```
157+
// type IdInfo: 'static = ();
158+
// ```
158159
type IdInfo: 'static;
159160

160161
/// The table of OF device ids supported by the driver.

0 commit comments

Comments
 (0)