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

Improve warnings for FeatureEnvy and UitilityFunction #702

Closed
troessner opened this issue Sep 13, 2015 · 3 comments
Closed

Improve warnings for FeatureEnvy and UitilityFunction #702

troessner opened this issue Sep 13, 2015 · 3 comments

Comments

@troessner
Copy link
Owner

Right now:

UtilityFunction: "doesn't depend on instance state"
FeatureEnvy: "refers to #{name} more than self"

I suggest to change this to:

UtilityFunction: "doesn't depend on instance state (maybe move it to another class?)"
FeatureEnvy: "refers to #{name} more than self (maybe move it to another class?)"

I can hear you scream "but the current message are correct!".
Yes, they are. But this is not academic software and our experience has clearly shown that users are very confused by the current messages, e.g. in #681

And yes, we could keep the existing messages around and add more information to our -U flag or something similar, but no novice is going to read that.

Let's make it as easy as possible for users.

WDYT?

@mvz
Copy link
Collaborator

mvz commented Sep 14, 2015

Sounds reasonable.

@tomash
Copy link

tomash commented Sep 14, 2015

Or maybe something along the lines of "see reek documentation for suggestions"?

@troessner
Copy link
Owner Author

Or maybe something along the lines of "see reek documentation for suggestions"?

I don't think that's gonna cut it. Indirect feedback is nice for experienced users, but I think the confusion generated by our current messages needs to be address directly and not by referring to another source.

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

No branches or pull requests

3 participants