rustdoc outputs text too large for text box

[olivia-banks]

Problem

I created a crate with a file that is included at compile time with include_str!. When I generated the docs, I found that the file content was also printed in the documentation, and since it was rather long, it exceeded the dialog box.

Steps

1. Include a file in a crate, that is contained within a global constant
2. Generate the documentation
3. Navigate to the documentation, and see roughly was is in the attached image.

Possible Solution(s)

No response

Notes

Link to image.

Version

cargo 1.55.0 (32da73ab1 2021-08-23)
release: 1.55.0
commit-hash: 32da73ab19417aa89686e1d85c1440b72fdf877d
commit-date: 2021-08-23

[ehuss]

Transferred to rust-lang/rust, as rustdoc issues are tracked here.

[jyn514]

I think we should consider omitting any text that would overflow the code block altogether. I'm not sure of a good syntax for that though; "struct VertexOutput { ..." makes it look like the ... is part of the string itself, not a meta-syntax added by rustdoc.

[olivia-banks]

Could the offending text be replaced with omitted, but italicized?

It wouldn't look like part of the string because it's not surrounded by quotes (and in the case of globals it's not capitalized, not to mention you can't have an italic string like that).

[jsha]

@IsaccBarker I see you're running cargo 1.55.0 (32da73ab1 2021-08-23). @GuillaumeGomez recently landed some fixes for long names: #90018. Does that fix the issue?

[GuillaumeGomez]

It seems to be fixed so closing.