fix wordwrap of hyphens at limit#67
Open
JaredReisinger wants to merge 3 commits intomuesli:masterfrom
Open
Conversation
If the word-thus-far is exactly at the limit and `wordwrap.Write` sees a hyphen, it writes the word to the buffer *and the hyphen*, exceeding the limit. This change fixes that behavior by instead adding the byphen to the word "as normal", and *then* checking to see if the word will fit within the limit. If it does, only then will it flush the word to the buffer. Fix muesli#66
|
This fixes a bug I was experiencing when starting lines with hyphens. I used the following simple program to demonstrate my issue: func main() {
fmt.Println(wrap.String(wordwrap.String("- This line wraps incorrectly on upstream reflow due to a silly bug regarding the handling of hyphens", 80), 80))
}When run with upstream reflow, the line wraps incorrectly: - This line wraps incorrectly on upstream reflow due to a silly bug regarding th
e
handling of hyphensWhen run with this PR, the line wraps correctly: |
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.
If the word-thus-far is exactly at the limit and
wordwrap.Write()sees a hyphen, it writes the word to the buffer and then writes hyphen, exceeding the limit. This change fixes that behavior by instead adding the hyphen to the word as a normal character, performing the existing "is the word-in-progress too long" check to add a newline, and then writing the word-in-progress (without any length check).It is still possible to see a hyphen beyond the limit, but that's a specific case of "don't break a word", where the hyphen is considered a part of the test to its left.
Fixes #66