Clean kernel::block::mq::Request docs to render properly
#1108
Labels
• docs
Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...
easy
Expected to be an easy issue to resolve.
good first issue
Good for newcomers
Comments
ojeda
added
• docs
|
Hi! Thanks for the very clear write-up. I would like to work on this issue. |
|
You're welcome -- please go ahead! |
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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. Additionally, to ensure that intra-doc links are rendered for private types, add the `--document-private-items` flag to all rustdoc invocations. Finally, update the Rust coding guidelines to mention the syntax for intra-doc links. Closes: Rust-for-Linux#1108 Signed-off-by: Francesco Zardi <frazar0@hotmail.it>
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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. Additionally, to ensure that intra-doc links are rendered for private types, add the `--document-private-items` flag to all rustdoc invocations. Finally, update the Rust coding guidelines to mention the syntax for intra-doc links. Closes: Rust-for-Linux#1108 Signed-off-by: Francesco Zardi <frazar0@hotmail.it> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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. Additionally, to ensure that intra-doc links are rendered for private types, add the `--document-private-items` flag to all rustdoc invocations. Finally, update the Rust coding guidelines to mention the syntax for intra-doc links. Closes: Rust-for-Linux#1108 Signed-off-by: Francesco Zardi <frazar0@hotmail.it> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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. Additionally, to ensure that intra-doc links are rendered for private types, add the `--document-private-items` flag to all rustdoc invocations. Finally, update the Rust coding guidelines to mention the syntax for intra-doc links. Closes: Rust-for-Linux#1108 Signed-off-by: Francesco Zardi <frazar00@gmail.com> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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 <frazar00@gmail.com> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
frazar
added a commit
to frazar/linux
that referenced
this issue
Sep 1, 2024
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 <frazar00@gmail.com> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are several documentation rendering issues in
rust/kernel/block/mq/request.rs. For instance, there is an ordered list not rendering as such in -- clean it up so that it is rendered properly. There is also some inline code missing Markdown quotes nearby -- clean it up too. There are also some references to types that could be intra-doc links and/or are missing Markdown quotes.This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a
Suggested-by:tag and aLink:tag to this issue. Please see https://rust-for-linux.com/contributing for details.Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.
The text was updated successfully, but these errors were encountered: