Fix blank line before declarations rule code example
#2657
Merged
Conversation
This file contains 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
k-taro56
changed the title
blank line before declarations rule code example
| @@ -59,22 +59,22 @@ Requires a blank line before any class or function declaration. No blank line is | |||
| === "[:material-heart:](#) Ktlint" | |||
|
|
|||
| ```kotlin | |||
| const val FOO_1 = "foo1" | |||
There was a problem hiding this comment.
FOO_1 is used intentionally. Constant value which are deeply immutable property should be written in screaming case according to property-naming rule. Of course it should have been consistent with the disallowed example.
| @@ -59,22 +59,22 @@ Requires a blank line before any class or function declaration. No blank line is | |||
| === "[:material-heart:](#) Ktlint" | |||
|
|
|||
| ```kotlin | |||
| const val FOO_1 = "foo1" | |||
| const val foo1 = "foo1" | |||
There was a problem hiding this comment.
FOO_1 is used intentionally. Constant value which are deeply immutable property should be written in screaming case according to property-naming rule. Of course it should have been consistent with the disallowed example.
|
I learned a lot! Thank you :) |
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.
Description
The code example used to demonstrate disallowed code was correctly formatted (i.e., there were blank lines before declarations). This change corrects the example to properly reflect code that violates the rule.
Checklist
Before submitting the PR, please check following (checks which are not relevant may be ignored):
Closes #<xxx>orFixes #<xxx>(replace<xxx>with issue number)Documentation is updated. See difference between snapshot and release documentation