Skip to content

docs: rust: fix formatting for kernel::block::mq::Request - #1111

Open
frazar wants to merge 1 commit into
Rust-for-Linux:rust-nextfrom
frazar:fix-1108
Open

docs: rust: fix formatting for kernel::block::mq::Request#1111
frazar wants to merge 1 commit into
Rust-for-Linux:rust-nextfrom
frazar:fix-1108

Conversation

@frazar

@frazar frazar commented Sep 1, 2024

Copy link
Copy Markdown

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: #1108

Suggested-by: Miguel Ojeda ojeda@kernel.org

@frazar

frazar commented Sep 1, 2024

Copy link
Copy Markdown
Author

If possible, I would like to receive a review of this patch. In particular, on the way I configured the Makefiles to pass the --document-private-items argument to rustdoc.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is nice adding the explanation, but I think we should also keep the original sentence.

This should be an independent commit, too.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I have removed these changes from the commit. Should I submit them as a second PR?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment thread Makefile Outdated
Comment thread rust/kernel/block/mq/request.rs Outdated
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>
@ojeda

ojeda commented Sep 3, 2024

Copy link
Copy Markdown
Member

@ojeda
ojeda force-pushed the rust-next branch 3 times, most recently from c9b5ce6 to ce1c54f 比较 October 9, 2024 22:37
@ojeda
ojeda force-pushed the rust-next branch 3 times, most recently from 9ee7197 to 6ce162a 比较 October 15, 2024 21:11
@ojeda
ojeda force-pushed the rust-next branch 5 times, most recently from bfc3cd8 to a3b2347 比较 May 27, 2025 18:27
@ojeda
ojeda force-pushed the rust-next branch 3 times, most recently from 5d132fa to 3b83f5d 比较 October 22, 2025 05:47
@ojeda
ojeda force-pushed the rust-next branch 2 times, most recently from fcb1014 to 3a2486c 比较 March 30, 2026 00:05
@ojeda
ojeda force-pushed the rust-next branch 2 times, most recently from 7c678ba to 438700e 比较 April 3, 2026 21:23
@ojeda
ojeda force-pushed the rust-next branch 3 times, most recently from 4fedd76 to 759da9e 比较 June 9, 2026 02:16
@ojeda
ojeda force-pushed the rust-next branch 6 times, most recently from 4cb8438 to d8973c4 比较 August 10, 2026 05:58
@ojeda
ojeda force-pushed the rust-next branch 4 times, most recently from a417b54 to 47f2715 比较 August 13, 2026 11:41
注册 for free to join this conversation on GitHub. Already have an account? 登录 to comment

标签

None yet

Development

Successfully merging this pull request may close these issues.

Clean kernel::block::mq::Request docs to render properly

2 participants