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

Adding context to rules #18

Open
Mkohm opened this issue Jan 27, 2020 · 2 comments
Open

Adding context to rules #18

Mkohm opened this issue Jan 27, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@Mkohm
Copy link
Owner

Mkohm commented Jan 27, 2020

Since many programming principles can be confusing and easily misinterpreted, i think adding some context in the comment could be helpful. In addition to giving a rule of thumb when to use composition over inheritance one could also print the public interface of the different classes.

@Mkohm Mkohm added the enhancement New feature or request label Jan 28, 2020
@Mkohm Mkohm changed the title Adding context to rules, links to where one can read more? Adding context to rules Jan 28, 2020
@ntindle
Copy link

ntindle commented Jan 28, 2020

Add a readme for each rule?

@Mkohm
Copy link
Owner Author

Mkohm commented Jan 28, 2020

@ntindle that is a good idea, and thanks for looking into the project! A readme/documentation defining the specifications should be created. As a beginning i think the project readme can contain this information.

Going back to the topic; how much context would be useful in such detections? The comment from the Bot would potentially be very long and make more noise than neccesary. Maybe an option to enable "verbose-super hint mode" could be nice. Just thinking out loud!

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

No branches or pull requests

2 participants