Skip to content

Commit 17b00db

Browse files
Updating docs for Py Config
1 parent c805e58 commit 17b00db

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

docs/changelog.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## July 9, 2025
9+
10+
### Python Static Analysis Tools Configuration Requirement
11+
12+
We've updated our Python static analysis tools to ensure they run only with proper configuration files:
13+
14+
- **[Pylint](https://docs.coderabbit.ai/tools/pylint)**: Now requires a configuration file (`.pylintrc`, `pylintrc`, `.pylintrc.toml`, or `pylintrc.toml`) to run. CodeRabbit will not run Pylint if no config file is found.
15+
16+
- **[Flake8](https://docs.coderabbit.ai/tools/flake8)**: Requires a `.flake8` configuration file to run. CodeRabbit will not run Flake8 if no config file is found.
17+
18+
This ensures that these tools operate with your project's specific coding standards and preferences. For detailed configuration information, refer to our [Pylint](/tools/pylint) and [Flake8](/tools/flake8) documentation pages.
19+
820
## July 3, 2025
921

1022
### Enhanced Python Static Analysis: Flake8 Support

docs/tools/flake8.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@ Flake8 will run on files with the following extensions:
1818

1919
- `*.py`
2020

21+
## Configuration
22+
23+
Flake8 supports the following config files:
24+
25+
- `.flake8`
26+
27+
CodeRabbit will not run Flake8 if no config file is found.
28+
2129
## Features
2230

2331
Flake8 can detect many issues such as:

docs/tools/pylint.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ Pylint will run on files with the following extensions:
1818

1919
- `*.py`
2020

21+
## Configuration
22+
23+
Pylint supports the following config files:
24+
25+
- `.pylintrc`
26+
- `pylintrc`
27+
- `.pylintrc.toml`
28+
- `pylintrc.toml`
29+
30+
CodeRabbit will not run Pylint if no config file is found.
31+
2132
## Features
2233

2334
Pylint can detect many issues such as:

0 commit comments

Comments
 (0)