Limit paragraph max-width in API docs#15672
Merged
straight-shoota merged 1 commit intocrystal-lang:masterfrom Apr 19, 2025
Merged
Limit paragraph max-width in API docs#15672straight-shoota merged 1 commit intocrystal-lang:masterfrom
max-width in API docs#15672straight-shoota merged 1 commit intocrystal-lang:masterfrom
Conversation
ysbaddaden
approved these changes
Apr 17, 2025
Collaborator
ysbaddaden
left a comment
ysbaddaden
left a comment
There was a problem hiding this comment.
Definitely better.
Apparently the maximum paragraph should be around 75 characters, according to typographers: https://css-tricks.com/six-tips-for-better-web-typography/#aa-rule-1-set-a-good-max-width-for-paragraphs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Limits the width of text paragraphs in the API docs for increased readability.
Previously, the width was unlimited, which leads to long line lengths that are hard to read.
Body copy:
The exact width may be up for debate. But 42em seems good to me.
Also limits the width of inherited methods, but they get more space because it's not body copy.
Inherited methods list: