-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add documentation for fixes #7901
Conversation
Ah mdformat puts code fences on admonitions... will need to investigate. Maybe relevant cljdoc/cljdoc#95 edit: resolved, there's a plugin for this at https://github.com/KyleKing/mdformat-admon which is recommended by the mdformat-mkdocs plugin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! Very clear.
|
||
### Fix safety | ||
|
||
Ruff labels fixes as "safe" and "unsafe". The meaning and intent of your code will be retained when applying safe fixes, but the meaning could be changed when applying unsafe fixes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should show an example here of what we consider safe and unsafe so users get a rough idea what "change meaning" entails
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea I was considering that but didn't know a good example off the top of my head. Maybe Charlie does? Let's address this in a follow-up.
CodSpeed Performance ReportMerging #7901 will improve performances by 9.59%Comparing Summary
Benchmarks breakdown
|
Per review in #7901 adds an example of an unsafe fix.
Adds documentation for using
ruff check . --fix
Uses the draft of the "Automatic fixes" section from #7732 and adds documentation for unsafe fixes, applicability levels, and #7841
I enabled admonitions because they're nice. We should use them more.