Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't break/wrap in the middle of a word #156

Open
aimurphy opened this issue Aug 15, 2024 · 3 comments
Open

Don't break/wrap in the middle of a word #156

aimurphy opened this issue Aug 15, 2024 · 3 comments
Labels
enhancement New feature or request quick win

Comments

@aimurphy
Copy link
Contributor

aimurphy commented Aug 15, 2024

I can't remember where/if I filed an issue for this already, but the mid-word line breaks are hard to read and potentially error-causing, especially when it happens with code. For example, in this table someone could misunderstand the hyphens as part of the parameter names:

image

I tested if this was a viewport issue, and it is not. Even at max width, it still does this.

image

@eric-schneider
Copy link
Contributor

@aimurphy are you specifically talking about wrapping within tables, or do you you think we should turn off wrapping everywhere? Tables definitely introduce a lot of strict space constraints that can be tricky to accommodate. You can make the text monospace to prevent the hyphens from showing up, but it will still wrap aggressively in a table like this.

@aimurphy
Copy link
Contributor Author

I think we should turn off mid-word wrap everywhere. It's just hard to read and there are various ways it could cause complications. Code strings are one example, but also words like "invalid", where "in" is on one line and "valid" starts on the next line, could be misread as valid, etc.

I know some wrapping is inevitable, but the mid-word break is usually not necessary, and in some cases it even seem excessive.

In the case of that table, I would expect the code string to break/wrap at the _ without a hyphen.

@aimurphy
Copy link
Contributor Author

Here are some more examples where the mid-word breaking is just going overboard:

image

image

image

image

@eric-schneider eric-schneider added enhancement New feature or request quick win labels Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request quick win
Projects
None yet
Development

No branches or pull requests

2 participants