Content-Length: 4686 | pFad | http://github.com/coderabbitai/coderabbit-docs/pull/436.patch

thub.com From 17b00db95f9dd4a668e3907e01e8c92345050f10 Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Wed, 9 Jul 2025 10:50:57 -0400 Subject: [PATCH 1/3] Updating docs for Py Config --- docs/changelog.md | 12 ++++++++++++ docs/tools/flake8.md | 8 ++++++++ docs/tools/pylint.md | 11 +++++++++++ 3 files changed, 31 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index e9d04422..4efb6c7a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,6 +5,18 @@ description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- +## July 9, 2025 + +### Python Static Analysis Tools Configuration Requirement + +We've updated our Python static analysis tools to ensure they run only with proper configuration files: + +- **[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. + +- **[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. + +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. + ## July 3, 2025 ### Enhanced Python Static Analysis: Flake8 Support diff --git a/docs/tools/flake8.md b/docs/tools/flake8.md index b0a29761..953187c7 100644 --- a/docs/tools/flake8.md +++ b/docs/tools/flake8.md @@ -18,6 +18,14 @@ Flake8 will run on files with the following extensions: - `*.py` +## Configuration + +Flake8 supports the following config files: + +- `.flake8` + +CodeRabbit will not run Flake8 if no config file is found. + ## Features Flake8 can detect many issues such as: diff --git a/docs/tools/pylint.md b/docs/tools/pylint.md index f6793106..65dcf703 100644 --- a/docs/tools/pylint.md +++ b/docs/tools/pylint.md @@ -18,6 +18,17 @@ Pylint will run on files with the following extensions: - `*.py` +## Configuration + +Pylint supports the following config files: + +- `.pylintrc` +- `pylintrc` +- `.pylintrc.toml` +- `pylintrc.toml` + +CodeRabbit will not run Pylint if no config file is found. + ## Features Pylint can detect many issues such as: From 523122246c66f39c09055f224a1c0e55d56f9fdd Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Wed, 9 Jul 2025 10:54:09 -0400 Subject: [PATCH 2/3] tools --- docs/changelog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index 4efb6c7a..0f0e1902 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -9,7 +9,7 @@ sidebar_position: 13 ### Python Static Analysis Tools Configuration Requirement -We've updated our Python static analysis tools to ensure they run only with proper configuration files: +We've updated Pylint and Flake8 to ensure they run only with proper configuration files: - **[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. From 58ffbe57e1ba71f08b687bca19b806d68ac9c66a Mon Sep 17 00:00:00 2001 From: nimratcoderabbit Date: Wed, 9 Jul 2025 11:01:56 -0400 Subject: [PATCH 3/3] Changelog --- docs/changelog.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 0f0e1902..e9d04422 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -5,18 +5,6 @@ description: The latest updates and changes to CodeRabbit. sidebar_position: 13 --- -## July 9, 2025 - -### Python Static Analysis Tools Configuration Requirement - -We've updated Pylint and Flake8 to ensure they run only with proper configuration files: - -- **[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. - -- **[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. - -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. - ## July 3, 2025 ### Enhanced Python Static Analysis: Flake8 Support

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!