fix: stop docs table-cell code breaking mid-token#414
Merged
Conversation
The article-wide `overflow-wrap: anywhere` broke inline code like `str | None` character-by-character when a param table's type column was squeezed by a long description. Keep cell code on one line; wide tokens use the wrapper's scroll.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation stylesheet adds a markdown-table-specific rule that keeps inline code on one line and disables arbitrary word breaking within table cells. ChangesTable Code Wrapping
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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.
Problem
In parameter tables, a narrow Type column (squeezed by a long Description) rendered inline code like
str | Nonebroken character-by-character — e.g.st/r |/Non/estacked vertically.Cause
The article-wide
overflow-wrap: anywhererule (added for long identifiers on phones) applies to inline code inside table cells too, so a squeezed column breaks short type tokens at every character.Fix
Scope table-cell inline code to
white-space: nowrap; overflow-wrap: normal, so types/defaults/identifiers stay on one line. Genuinely wide tokens fall back to the table wrapper's existingoverflow-x: autohorizontal scroll instead of mangling.Verification
Headless render of the affected table, 760px container: the Type cell height drops from 52px (3 wrapped lines) to 16px (one line). Docs typecheck + lint clean.
Summary by CodeRabbit