Conversation
Google Java Style requires the opening """ of a text block to be on its own line. visitReturn used a plain space before the expression, so `return """` stayed on one line (it fits) and content indentation was wrong. Force a +4 break when the return expression is a text block. Fixes google#1258
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
1 participant
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.
Summary
Fixes #1258.
visitReturnalways emitted a space before the expression. For ordinary expressions that is correct, but for text blocks Google Java Style (§4.8.9) wants the opening delimiter on its own line:Because
return """fits on one line, a fill-mode break never fires and the formatter previously kept the delimiter attached toreturn, producing incorrect content indentation (confirmed by @cushon on the issue).Change
visitReturnand emit a forced+4break before scanning them (same structural idea as assignment / variable initializers).return "…"formatting unchanged.Test plan
mvn -pl core -Dtest=FormatterTest#returnTextBlockStartsOnOwnLine+returnOrdinaryStringUnchanged test— 2/2mvn -pl core -Dtest=FormatterTest,StringWrapperTest test— 49/49