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

Add clarification for IDEA setup in README #1017

Merged
merged 1 commit into from
Dec 17, 2020
Merged

Add clarification for IDEA setup in README #1017

merged 1 commit into from
Dec 17, 2020

Conversation

Woodz
Copy link
Contributor

@Woodz Woodz commented Dec 17, 2020

To clarify how the IntelliJ IDEA code style setting configuration process works, add an brief explanation about what each command does and clarify that the code samples are command line calls, not config file entries

To clarify how the IntelliJ IDEA code style setting configuration process works, add an brief explanation about what each command does and clarify that the code samples are command line calls, not config file entries
@romtsn
Copy link
Collaborator

romtsn commented Dec 17, 2020

Thanks for the PR, but I am not sure how it wasn't clear from the previous readme?

@Woodz
Copy link
Contributor Author

Woodz commented Dec 17, 2020

Thanks for the PR, but I am not sure how it wasn't clear from the previous readme?

Given that the majority of users will not use the ktlint executable directly (instead would run via build tool plugin), it was not clear whether ktlint applyToIDEAProject was a shell command or a setting in a file. I misunderstood that this was a config to be used inside .editorconfig file, which obviously didn't work. It was only when I re-read the entire README and found the "Installation" section that mentioned that it could be run as a standalone binary that I understood that this was a shell command. I think part of the issue is that the .sh code highlighting in GitHub does not show that it is a shell script, so even though the previous README contained the full information needed to understand how to use it, the way GitHub presented it left some room for confusion.

Since I was silly and wasted half an hour getting confused, I really wanted to avoid it happening again, hence this PR :-)

@romtsn
Copy link
Collaborator

romtsn commented Dec 17, 2020

Oh ok, I see.. Well, if that would help you, I am fine with merging this in 👍

@romtsn romtsn merged commit 08a4095 into pinterest:master Dec 17, 2020
@Woodz
Copy link
Contributor Author

Woodz commented Dec 17, 2020

Oh ok, I see.. Well, if that would help you, I am fine with merging this in 👍

Thanks! Appreciate your time reviewing and merging this in :-)

romtsn pushed a commit to paul-dingemans/ktlint that referenced this pull request Mar 7, 2021
To clarify how the IntelliJ IDEA code style setting configuration process works, add an brief explanation about what each command does and clarify that the code samples are command line calls, not config file entries
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