Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix blank line before declarations rule code example #2657

Merged
merged 2 commits into from
May 19, 2024

Conversation

k-taro56
Copy link
Contributor

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):

  • Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
  • At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
  • Tests are added
  • KtLint format has been applied on source code itself and violations are fixed
  • PR title is short and clear (it is used as description in the release changelog)
  • PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

  • Snapshot documentation in case documentation is to be released together with a code change
  • Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master

@k-taro56 k-taro56 changed the title Fix `blank line before declarations' rule code example Fix blank line before declarations rule code example May 16, 2024
Copy link
Collaborator

@paul-dingemans paul-dingemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tnx for fixing. I will make a slight alteration before merge.

@@ -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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@paul-dingemans paul-dingemans merged commit 7d0536a into pinterest:master May 19, 2024
11 checks passed
@k-taro56
Copy link
Contributor Author

I learned a lot! Thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants