Docs generator producing bad line endings #5111
Merged
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
When generating docs locally I noticed that some of the callouts only included a newline and were missing the carriage return. Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n.
Mpdreamz
approved these changes
Nov 20, 2020
github-actions bot
pushed a commit
that referenced
this pull request
Nov 20, 2020
When generating docs locally I noticed that some of the callouts only included a newline and were missing the carriage return. Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n.
github-actions bot
pushed a commit
that referenced
this pull request
Nov 20, 2020
When generating docs locally I noticed that some of the callouts only included a newline and were missing the carriage return. Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n.
stevejgordon
added a commit
that referenced
this pull request
Nov 23, 2020
When generating docs locally I noticed that some of the callouts only included a newline and were missing the carriage return. Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n. Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
stevejgordon
added a commit
that referenced
this pull request
Nov 23, 2020
When generating docs locally I noticed that some of the callouts only included a newline and were missing the carriage return. Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n. Co-authored-by: Steve Gordon <sgordon@hotmail.co.uk>
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.
Exclude matching \r\n
When generating docs locally, on Windows, after running the tool, all files which include callouts then showed as modified, making review very difficult. I noticed that some of the callouts only included a newline (\n) and were missing the carriage return (\r).
Upon investigation, I found that the regex used for callout replacement was catching and removing the \r character. This change fixes the two places such replacement may occur and ensures we stop matching before the \r\n.
I'm not super hot on Regex so welcome opinions on the approach!