docs: rust: fix formatting for kernel::block::mq::Request #1111
Conversation
|
If possible, I would like to receive a review of this patch. In particular, on the way I configured the Makefiles to pass the |
| @@ -162,7 +162,7 @@ in the kernel: | |||
| a section called ``# Examples``. | |||
|
|
|||
| - Rust items (functions, types, constants...) must be linked appropriately | |||
| (``rustdoc`` will create a link automatically). | |||
| by wrapping them with square brackets (e.g. ``[`Foo::bar()`]``). | |||
There was a problem hiding this comment.
It is nice adding the explanation, but I think we should also keep the original sentence.
This should be an independent commit, too.
There was a problem hiding this comment.
Thank you! I have removed these changes from the commit. Should I submit them as a second PR?
There was a problem hiding this comment.
You're welcome! I think they would be 3 independent PRs, since they are mostly independent (i.e. the cleanup, the docs improvement and the proposal to document private items; the latter likely being an RFC). In any case, please note that each change that you want to submit will need to end up in the mailing list -- we don't really use PRs anymore, except for early reviews like this one. Thanks!
Fix several issues with rustdoc formatting for the `kernel::block::mq::Request` module, in particular: - An ordered list not rendering correctly. - Code snippets formatted as regular text. - References to types missing intra-doc links. Closes: Rust-for-Linux#1108 Signed-off-by: Francesco Zardi <[email protected]> Suggested-by: Miguel Ojeda <[email protected]>
ojeda
force-pushed
the
rust-next
branch
3 times, most recently
from
c9b5ce6 to
ce1c54f
Compare
ojeda
force-pushed
the
rust-next
branch
3 times, most recently
from
9ee7197 to
6ce162a
Compare
Fix several issues with rustdoc formatting for the
kernel::block::mq::Requestmodule, in particular:An ordered list not rendering correctly.
Code snippets formatted as regular text.
References to types missing intra-doc links.
Closes: #1108
Suggested-by: Miguel Ojeda [email protected]