Add documentation for fixes #7901
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
charliermarsh
approved these changes
Oct 10, 2023
dhruvmanila
approved these changes
Oct 11, 2023
konstin
approved these changes
Oct 11, 2023
|
|
||
| ### 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.
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.
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
|
zanieb
added a commit
that referenced
this pull request
Oct 11, 2023
Per review in #7901 adds an example of an unsafe fix.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for using
ruff check . --fixUses 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.