build: Allow arbitrary line length in markdown documents #1250
Conversation
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
jimmidyson
changed the title
jimmidyson
approved these changes
Aug 5, 2025
jimmidyson
force-pushed
the
dlipovetsky/no-line-length-markdown
branch
from
09c9c66 to
5cf4548
Compare
mhrabovcin
approved these changes
Aug 5, 2025
Member
|
Updated commit and PR title to fit with our conventional commits configuration (no |
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.
What problem does this PR solve?:
Maintaining a maximum line length is not necessary.
We view Markdown documents using clients that can (and do) automatically wrap text to the width of the display.
Moreover, when we render Markdown to HTML using Hugo, the most important use case for most of Markdown documentation, the line wrapping is discarded.
We already disabled line length for code blocks. This PR just extends it to text.
Which issue(s) this PR fixes:
Fixes #
How Has This Been Tested?:
Special notes for your reviewer: