documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Fix long code blocks

Open kaelynj opened this issue 4 months ago • 4 comments

Some of the code blocks in our docs pages have lines which are too long and create a horizontal scroll bar across such as the one below:

Image

This is a minor annoyance, but can be fixed pretty easily by shortening the length of the offending line. I'm not sure how many characters exactly creates a scroll bar, but we should have something reasonable.

To address this, we'll have to correct these by finding all the offending code blocks and fix them by hand.

kaelynj avatar Aug 22 '25 14:08 kaelynj

Looks like we have a similar infra issue in #1806. Let's look into just making a CI check and automating this.

kaelynj avatar Aug 28 '25 15:08 kaelynj

Hi! I'd like to work on this issue. Could you please assign it to me?

manasa-manoj-nbr avatar Oct 26 '25 15:10 manasa-manoj-nbr

Thanks @manasa-manoj-nbr, assigning you!

abbycross avatar Oct 27 '25 14:10 abbycross

@manasa-manoj-nbr Thanks for volunteering! Have you had a chance to take a look at this issue or should it be unassigned for now?

lerongil avatar Nov 17 '25 16:11 lerongil