Skip to content

Commit b12376e

Browse files
adding npqa notes (#439)
1 parent 6a197c5 commit b12376e

File tree

6 files changed

+21
-4
lines changed

6 files changed

+21
-4
lines changed

docs/changelog.md

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

8+
## July 10, 2025
9+
10+
### Enhanced Python Static Analysis: nbqa Support for Jupyter Notebooks
11+
12+
We're excited to announce enhanced Python static analysis capabilities with nbqa support for Jupyter Notebooks!
13+
14+
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.
15+
16+
See our [Ruff](/tools/ruff), [Flake8](/tools/flake8), and [Pylint](/tools/pylint) documentation for more details.
17+
818
## July 3, 2025
919

1020
### Enhanced Python Static Analysis: Flake8 Support

docs/guides/code-review-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ perform a code review:
4848

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

51-
- 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.
51+
- 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.
5252
- 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.
5353

5454
<ProPlanNotice />

docs/tools/flake8.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[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.
13+
[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.
1414

1515
## Supported Files
1616

1717
Flake8 will run on files with the following extensions:
1818

1919
- `*.py`
20+
- `*.ipynb` (using nbqa)
2021

2122
## Configuration
2223

@@ -42,3 +43,4 @@ Flake8 can detect many issues such as:
4243
- [Flake8 GitHub Repository](https://github.com/pycqa/flake8)
4344
- [Flake8 Documentation](https://flake8.pycqa.org/en/latest/)
4445
- [Flake8 Configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
46+
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)

docs/tools/list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
3737
| Java | [PMD][PMD] | Code Quality |
3838
| Protobuf | [Buf][Buf] | Code Quality |
3939
| Python | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
40+
| Jupyter Notebooks | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
4041
| Regal | [Regal][Regal] | Code Quality |
4142
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
4243
| Rust | [Clippy][Clippy] | Code Quality |

docs/tools/pylint.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

13-
[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.
13+
[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.
1414

1515
## Supported Files
1616

1717
Pylint will run on files with the following extensions:
1818

1919
- `*.py`
20+
- `.ipynb` (using nbqa)
2021

2122
## Configuration
2223

@@ -46,3 +47,4 @@ Pylint can detect many issues such as:
4647
- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint)
4748
- [Pylint Documentation](https://pylint.pycqa.org/en/latest/)
4849
- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html)
50+
- [nbqa Documentation](https://github.com/nbQA-dev/nbQA)

docs/tools/ruff.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1010
<ProPlanNotice />
1111
```
1212

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

1515
## Files
1616

1717
Ruff will run on files with the following extensions:
1818

1919
- `.py`
20+
- `.ipynb` (using nbqa)
2021

2122
## Configuration
2223

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

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

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy