-
Notifications
You must be signed in to change notification settings - Fork 281
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
Simplify SmellWarning class #1489
Conversation
4044401
to
b02f2b7
Compare
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.
Very nice! One tiny comment and then let's merge :)
|
||
# @note When using Reek's public API, you should not create SmellWarning | ||
# objects yourself. This is why the initializer is not part of the | ||
# public API. | ||
# | ||
# @quality :reek:LongParameterList { max_params: 6 } | ||
def initialize(smell_detector, context: '', lines:, message:, | ||
def initialize(smell_type, context: '', lines:, message:, |
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.
Let's use this opportunity to add proper parameter documentation :)
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.
Done!
Hm. Can we not squash merge? I really hate it. |
You mean not squash anymore at all or are you referring to this specific case? If it's the latter, how about leaving a comment for the reviewer (or label it) that we shouldnt squash on merge? |
I mean in general not use GitHub's squash merge option. |
A short list of why I don't like it:
|
Ok, no worries, I'm ok with not using it anymore :) |
SmellWarning#initialize