-
Notifications
You must be signed in to change notification settings - Fork 88
Github Not Fully Highlighting Diff #23
Comments
Today I reported this challenge to github. Waiting their reply. I'll post it here if any. |
Reply from Rachel, GitHub staff
|
Thanks @Francewhoa, for solving the mystery! Really hope GitHub does increase that 512 char limit, because that is effectively limiting writers to 512 char paragraphs—for those who subscribe to the one-line-per-paragraph approach as we do. |
@cbeams :) Yeah that limit is a party crasher for doc contributors. It also makes it harder for maintainers to review for approval pull request :( As you know documentation paragraphs often need to go over that limit. Simply because they are text visible to end-users, not line of codes, or in-line code comments visible to back-end software engineers. Also doc contributors need that full length for easy and quick automated doc spell checks, frequents updates. Plus a pleasant end-user experience when they read the doc on devices with different screen sizes with automated line brakes. Until that limit is removed, for my future pull requests, I'm happy to try to use the pull request comment field to try to manually clarify what the propose pull request is about. I mean using this pull request as an example, which one of the following two options is easier for you when you review future doc pull requests? Option 1: Diff location
Option 2: Manual diff
Option 3: What else?Do you have any other proposal to resolve this limit party-crasher challenge? Option 1 is easier for me. How about u? Option 2 might be challenging if there are multiple propose edits within the same sentence. |
Steps to reproduce
/bisq-network/docs
, edit thisphase-zero.adoc
filephase-zero.adoc
file. I was not able to reproduce this challenge with any other files within the same forked repository.Screenshot challenge
Notes
The text was updated successfully, but these errors were encountered: