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

Wrap three new experimental KtLint rules #2762

Merged
merged 1 commit into from
Jun 3, 2020

Conversation

arturbosch
Copy link
Member

No description provided.


### SpacingBetweenDeclarationsWithComments

See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation.
Copy link
Member Author

Choose a reason for hiding this comment

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

Note that KtLint does not update their website with new examples.

Copy link
Member

Choose a reason for hiding this comment

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

Where to they document the behavior then?

Copy link
Member Author

Choose a reason for hiding this comment

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

Kdoc and changelog

Copy link
Member

Choose a reason for hiding this comment

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

Then we should maybe link the source code or at least the package?

Copy link
Member

Choose a reason for hiding this comment

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

What do you think?

Copy link
Member Author

@arturbosch arturbosch Jun 4, 2020

Choose a reason for hiding this comment

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

Good idea, just checked only the ImportOrdering had this extensive documentation (which I already linked in the PR).
The other three rules not. Just a link to youtrack which is basically the same amount of information as the issue description we report :).
It won't help much to include the a link to youtrack or the ktlint rule...


### SpacingBetweenDeclarationsWithComments

See <a href="https://ktlint.github.io/#rule-spacing">ktlint-website</a> for documentation.
Copy link
Member

Choose a reason for hiding this comment

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

Where to they document the behavior then?

@arturbosch arturbosch merged commit c86f1d0 into master Jun 3, 2020
@arturbosch arturbosch deleted the add-experimental-ktlint-rules branch June 3, 2020 18:48
@arturbosch arturbosch added this to the 1.10.0 milestone Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants