Fix line too long translation string and comment#11092
Merged
Merged
Conversation
Fix-up of PR nvaccess#10941 Alternative to review action nvaccess#10941 (comment)
feerrenrut
approved these changes
May 4, 2020
feerrenrut
left a comment
Contributor
There was a problem hiding this comment.
@JulienCochuyt Thanks for the correction, and write up. Excellent stuff!
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.
Link to issue number:
Fix-up of PR #10941
Summary of the issue:
Finding the appropriate code style for a lengthy translatable string along with its required translators comment might not be obvious, even for some of our most seasoned contributors.
This problem has led to discussion about various attempts in PR #10941 and the raise of issue #11071.
PR #10941 finally resigned by disabling line length checks on a line of the patch.
Description of how this pull request fixes the issue:
As pointed out in #11071 (comment) a styling that complies both with line length and translators comment could finally be found.
The Contributing wiki page has then be updated accordingly.
While the disabling of line length check is of course not a bug, I guess it can be considered a misleading example for anyone that would not have read either this ticket or gettext manual
Testing performed:
Successfuly ran
scons lint,scons potandscons checkPotEnsured the translators comment landed in the
.potfile as expected.Known issues with pull request:
Change log entry:
None,