Weird formatting on documentation of "Summary" button

[lolbinarycat]

location: https://doc.rust-lang.org/nightly/std/#how-to-read-this-documentation

I believe this issue comes from using an svg element inside a code element.

[uellenberg]

This is due to "Summary" having a newline in it. You can see the newline in

rust/library/std/src/lib.rs

Lines 35 to 36 in 82c24ec

	//! development you may want to press the <code>
	//! <svg style="width:0.75rem;height:0.75rem" viewBox="0 0 12 12"

, where code is on a different line than the SVG.

I'm going to send in a modification, but I'm not sure how to document why that change is being made, so it doesn't happen again. A quick search through the code confirms that this is the only place where we have an inside a in a Rust source file.

@rustbot claim

[lolbinarycat]

I'm not sure how to document why that change is being made, so it doesn't happen again.

you can put a non-doc comment (//) next to the doc comment.

[uellenberg]

I'm not sure how to document why that change is being made, so it doesn't happen again.

you can put a non-doc comment (//) next to the doc comment.

Good idea!

On second thought, I don't love the idea of breaking up documentation with notes on why the documentation is formatted the way it is. I think this isn't so big of an issue that it needs to be commented on.

[lolbinarycat]

another option is coding a check into tidy that prevents putting newlines inside inline html elements (as opposed to block html elements, which can have newlines without much issue)