rust: pci: fix docs related to missing Markdown code spans
authorMiguel Ojeda <ojeda@kernel.org>
Mon, 24 Mar 2025 21:03:54 +0000 (22:03 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 25 May 2025 20:58:35 +0000 (22:58 +0200)
commit1dbaf8b1bafb8557904eb54b98bb323a3061dd2c
tree35a41d9da8a3242b5f01fcae76bcfd99c3dc0a12
parentabd21a163d4188c180cabb6747b1d94e3c0586b9
rust: pci: fix docs related to missing Markdown code spans

In particular:

  - Add missing Markdown code spans.

  - Improve title for `DeviceId`, adding a link to the struct in the
    C side, rather than referring to `bindings::`.

  - 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: 1bd8b6b2c5d3 ("rust: pci: add basic PCI device / driver abstractions")
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
Acked-by: Danilo Krummrich <dakr@kernel.org>
Link: https://lore.kernel.org/r/20250324210359.1199574-8-ojeda@kernel.org
[ Prefixed link text with `struct`. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/pci.rs