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

Be more precise in comment "Non Compliant" #2

Open
jhertout opened this issue Mar 13, 2023 · 2 comments
Open

Be more precise in comment "Non Compliant" #2

jhertout opened this issue Mar 13, 2023 · 2 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@jhertout
Copy link

Hi,

I think you should add more information in comments where issues are thrown. I will set an example:

Capture d’écran 2023-03-13 à 09 10 09

The line 58 triggers a rule, not related with the rule the file is supposed to test but, well, it is here. I think you should indicate in this case that an issue should be found at that line.
On the line 62, on the same idea, I think you should indicate in the comment the rule that we expect here, to be sure it is the good one that is detected.

Regards.

@jhertout jhertout changed the title be more precise in comment "Non Compliant" Be more precise in comment "Non Compliant" Mar 13, 2023
@dedece35
Copy link
Member

Hi,

First, indeed, you're right : I have to be more precise on the comment in the good line. I will do that.

Secondly, as you see, others issues are raised. I only copied the files already presents in resources of unit tests of original project. And, they already had some existing problems. I already corrected some previous easy issues but still existing ones aren't so simple to correct without refactoring all the file. I wanted to create quickly this project.

@dedece35 dedece35 self-assigned this Mar 13, 2023
@dedece35 dedece35 added bug Something isn't working documentation Improvements or additions to documentation labels Mar 13, 2023
@jhertout
Copy link
Author

OK, I think in some cases you will not have the choice and other issues will be raised in files that are tested a specific issue. We have this "problem" in the Android test project. We just add a comment as for other issues.

@dedece35 dedece35 removed their assignment Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants