-
Notifications
You must be signed in to change notification settings - Fork 277
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
improvement: Warn users not to use an example config without discussion #3710
Conversation
tgodzik
commented
Nov 27, 2023
•
edited
Loading
edited
it's a good solution. however, do we really need to mention that someone uses a particular value? just below, in the section about intellij applies 120 as a "hard right margin" (i e., maximum), regardless of language, with the option of adding the so-called "visual guides" at additional stops. and its original -- and, presumably, primary -- language is java, which has only one formatter (Google Java format) that uses the value of 100 and allows no customization. not a single formal language style, for scala or Java, which can be found online uses the value of 120 (scala-lang sort of mentions 80, while several others set it to 100). and, as I mentioned, intellij's global value is really a "nobody should go beyond that since it doesn't fit the screen anymore" rather than "let's pack as many characters as possible before this marker". in addition to "you should discuss internally" comment, but without a specific value suggested, we can change the example to something ridiculous, like 1234, so that no sane person uses it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as i mentioned above, published standards, specifically for scala, actually use 100, and intellij's 120 is not specific to scala, not published and not even used for java.
@kitbellew 💯 🙏 yes please! |
``` | ||
|
||
> 🚧 Before using specific configuration make sure that your project agrees on the standards. Settings such as `maxColumn` could be a source of issues if different tools such as an IDE uses a different default value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed the example and made the additional comment about the specific problem users might encounter.