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

Should parameter name change rules be removed? #63

Open
tomzx opened this issue May 28, 2015 · 4 comments
Open

Should parameter name change rules be removed? #63

tomzx opened this issue May 28, 2015 · 4 comments

Comments

@tomzx
Copy link
Owner

tomzx commented May 28, 2015

In all of the cases, a parameter name change generates a PATCH increment. Furthermore, changing a parameter name will also most likely imply method implementation changes as well which are also PATCH increment. Thus, those rules are most likely only generating noise, that is information that is not very interesting. Finally, it is generally of no interest to the callers/client code if a parameter name has changed.

Affected rules
V060 - Class public method parameter name changed
V061 - Class protected method parameter name changed
V062 - Class private method parameter name changed
V063 - Interface method parameter name changed
V064 - Trait public method parameter name changed
V065 - Trait protected method parameter name changed
V066 - Trait private method parameter name changed

Thus, I suggest the removal of the mentioned rules from the ruleset.

@tomzx tomzx added the question label May 28, 2015
@tomzx tomzx added this to the Candidate for next Minor milestone May 28, 2015
@mikeSimonson
Copy link
Contributor

Is it possible to keep them but not enable them in the default build ?

@tomzx
Copy link
Owner Author

tomzx commented May 28, 2015

That could be an alternative, but then that would open the door to having other rules not available in the default build... I wouldn't mind as long as they're adding value to the overall tool.

What value do you see in keeping those rules available?

@mikeSimonson
Copy link
Contributor

Maybe sometimes some people analysing the change of an api will want to know about the parameter name change just because there isn't any other change and it might improve their overall comprehension of the api they are using.

Or maybe you should get rid of it and not look back. I just wouldnl't reuse those rule numbers to avoid confusion.

@tomzx
Copy link
Owner Author

tomzx commented May 29, 2015

Rule number reuse is certainly out of the question. It is basically the main reason they're there to begin with: unique identifiers.

Thanks for your feedback!

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

No branches or pull requests

2 participants