Skip to content

Add Pylint Documentation to Tools Section #369

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

Merged
merged 6 commits into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ description: The latest updates and changes to CodeRabbit.
sidebar_position: 13
---

### May 30, 2025

#### New Static Analysis Tool

We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit!

- **Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files.

## May 25, 2025

### New Security and Code Quality Tools
Expand Down
3 changes: 2 additions & 1 deletion docs/tools/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
| Java | [PMD][PMD] | Code Quality |
| Protobuf | [Buf][Buf] | Code Quality |
| Python | [Ruff][Ruff] | Code Quality |
| Python | [Ruff][Ruff], [Pylint][Pylint] | Code Quality |
| Regal | [Regal][Regal] | Code Quality |
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
| Rust | [Clippy][Clippy] | Code Quality |
Expand Down Expand Up @@ -77,3 +77,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
[Luacheck]: /tools/luacheck.md
[Brakeman]: /tools/brakeman.md
[Clippy]: /tools/clippy.md
[Pylint]: /tools/pylint.md
37 changes: 37 additions & 0 deletions docs/tools/pylint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Pylint
sidebar_label: Pylint
description: CodeRabbit's guide to Pylint.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python. It checks your Python code for errors, enforces a coding standard, and looks for code smells.

## Supported Files

Pylint will run on files with the following extensions:

- `*.py`

## Features

Pylint can detect many issues such as:

- Coding standard violations (PEP8)
- Unused variables and imports
- Undefined variables
- Code smells and refactoring suggestions
- Error-prone constructs
- And many more

## Links

- [Pylint Official Website](https://pylint.pycqa.org/)
- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint)
- [Pylint Documentation](https://pylint.pycqa.org/en/latest/)
- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html)