Skip to content

Commit

Permalink
Update faq.md to highlight changes to src (#13145)
Browse files Browse the repository at this point in the history
This attempts to close #13134

## Summary

Documentation change to address
#13134

## Test Plan

Markdown Changes were previewed
  • Loading branch information
PalAditya committed Aug 29, 2024
1 parent a998320 commit b4d9d26
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,7 @@ conflicts with the isort rules, like `I001`).

Beyond the rule set, Ruff's primary limitation vis-à-vis Flake8 is that it does not support custom
lint rules. (Instead, popular Flake8 plugins are re-implemented in Rust as part of Ruff itself.)

There are a few other minor incompatibilities between Ruff and the originating Flake8 plugins:

- Ruff doesn't implement all the "opinionated" lint rules from flake8-bugbear.
- Depending on your project structure, Ruff and isort can differ in their detection of first-party
code. (This is often solved by modifying the `src` property, e.g., to `src = ["src"]`, if your
code is nested in a `src` directory.)
One minor difference is that Ruff doesn't include all the 'opinionated' rules from flake8-bugbear.

## How does Ruff's linter compare to Pylint?

Expand Down

0 comments on commit b4d9d26

Please sign in to comment.