Skip to content

adding npqa notes #439

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 1 commit into from
Jul 10, 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
10 changes: 10 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit.
sidebar_position: 13
---

## July 10, 2025

### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks

We're excited to announce enhanced Python static analysis capabilities with nbqa support for Jupyter Notebooks!

Our existing integrated [Ruff](https://docs.astral.sh/ruff/), [Flake8](https://flake8.pycqa.org/) and [Pylint](https://pylint.pycqa.org/) tools now support linting Jupyter Notebooks (`.ipynb` files) using [nbqa](https://github.com/nbQA-dev/nbQA). This allows you to maintain code quality across your Python projects, including Jupyter Notebooks.

See our [Ruff](/tools/ruff), [Flake8](/tools/flake8), and [Pylint](/tools/pylint) documentation for more details.

## July 3, 2025

### Enhanced Python Static Analysis: Flake8 Support
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/code-review-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ perform a code review:

CodeRabbit automatically reviews a pull request when **either** of the following statements is true:

- The pull request is in a public repository. CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan.
- The pull request is in a public repository. CodeRabbit reviews pull requests against the main branch of your public repositories by default. This feature is available to every subscription tier, including the free plan.
- The pull request is in a private repository and your organization is on the Pro plan with a seat assigned to you. Only under this condition does CodeRabbit review private-repository pull requests.

<ProPlanNotice />
Expand Down
4 changes: 3 additions & 1 deletion docs/tools/flake8.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.
[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python or Jupiter Notebook code for style and logical errors.

## Supported Files

Flake8 will run on files with the following extensions:

- `*.py`
- `*.ipynb` (using nbqa)

## Configuration

Expand All @@ -42,3 +43,4 @@ Flake8 can detect many issues such as:
- [Flake8 GitHub Repository](https://github.com/pycqa/flake8)
- [Flake8 Documentation](https://flake8.pycqa.org/en/latest/)
- [Flake8 Configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)
1 change: 1 addition & 0 deletions docs/tools/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
| Java | [PMD][PMD] | Code Quality |
| Protobuf | [Buf][Buf] | Code Quality |
| Python | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
| Jupyter Notebooks | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
| Regal | [Regal][Regal] | Code Quality |
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
| Rust | [Clippy][Clippy] | Code Quality |
Expand Down
4 changes: 3 additions & 1 deletion docs/tools/pylint.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ 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.
[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python or Jupiter Notebooks. 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`
- `.ipynb` (using nbqa)

## Configuration

Expand Down Expand Up @@ -46,3 +47,4 @@ Pylint can detect many issues such as:
- [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)
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)
4 changes: 3 additions & 1 deletion docs/tools/ruff.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[Ruff](https://docs.astral.sh/ruff/) is a linter for Python.
[Ruff](https://docs.astral.sh/ruff/) is a linter for Python or Jupiter Notebooks.

## Files

Ruff will run on files with the following extensions:

- `.py`
- `.ipynb` (using nbqa)

## Configuration

Expand All @@ -31,3 +32,4 @@ CodeRabbit will use the default settings based on the profile selected if no con
## Links

- [Ruff Configuration](https://docs.astral.sh/ruff/configuration/)
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)