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

Indicate what was autocorrected #501

Closed
bbatsov opened this issue Sep 20, 2013 · 5 comments · Fixed by #509
Closed

Indicate what was autocorrected #501

bbatsov opened this issue Sep 20, 2013 · 5 comments · Fixed by #509
Assignees

Comments

@bbatsov
Copy link
Collaborator

bbatsov commented Sep 20, 2013

Currently auto-correct is not particularly user friendly, since users get exactly the same output no matter whether they're doing a check or an auto-correction run. I think we should indicated somehow the offences that were autocorrected in the output. Maybe even display some one line summary about autocorrected stuff?

@yujinakayama @jonas054 @edzhelyov Ideas?

@jonas054
Copy link
Collaborator

Good idea. Using color to make reports about performed corrections stand apart from offences would be nice.

@yujinakayama
Copy link
Collaborator

👍

Probably we should add Offence#autocorrected? and display something like “corrected” along with offence message in some formatters?

And I think the final correction summary is also good. I guess the autocorrection feature is mainly used when there are too many offences to correct manually, so the user may miss the message “corrected” in each offence report.

@daviddavis
Copy link
Contributor

👍

I was confused the first time I ran autocorrection

@bbatsov
Copy link
Collaborator Author

bbatsov commented Sep 21, 2013

@yujinakayama Sounds good to me. Would you like to tackle this?

@yujinakayama
Copy link
Collaborator

@bbatsov Sure. I'll try.

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

Successfully merging a pull request may close this issue.

4 participants