chore: Let rustfmt format code in doc comments #1125
Conversation
sbernauer
force-pushed
the
chore/format-rustdoc
branch
from
e4340c1 to
282a975
Compare
| /// .service_name("test") | ||
| /// .build() | ||
| /// .init()?; | ||
| /// tracing::info!("log a message"); | ||
| /// Ok(()) // < Scope ends here, guard is dropped |
There was a problem hiding this comment.
This is a change we don't want.
There was a problem hiding this comment.
If there's a lint that allows for aligned comments, we could enable it here?
But we also want the empty lines.
There was a problem hiding this comment.
If there's a lint that allows for aligned comments
I have no clue if such a thing exists... But others also asked for this: https://users.rust-lang.org/t/rustfmt-and-alignment-of-trailing-comments/39121
I think the best option would be to use #[rustfmt::skip] here.
There was a problem hiding this comment.
My first try with #[rustfmt::skip] didn't work, now it did 🤷 7690e04
There was a problem hiding this comment.
This will technically disable formatting for the actual code (struct) as well, but I guess there is no other way around it. Or can we disable doc code formatting just for these doc comments?
There was a problem hiding this comment.
Most of these changes are a little weird.
Techassi
moved this from Development: Waiting for Review
to Development: In Review
in Stackable Engineering
Enable
format_code_in_doc_commentsand letcargo +nightly-2025-10-23 fmt --allformat the code.The unstable feature isn't perfect (there are some weird spaces being added), but in my opinion this is a significant improvement.