Skip to content
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
2 changes: 1 addition & 1 deletion .github/linters/.python-lint
Original file line number Diff line number Diff line change
Expand Up @@ -466,4 +466,4 @@ valid-metaclass-classmethod-first-arg=mcs

# Exceptions that will emit a warning when being caught. Defaults to
# "Exception"
overgeneral-exceptions=Exception
overgeneral-exceptions=builtins.Exception
8 changes: 4 additions & 4 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,24 +95,24 @@ We rely on [pylint](https://pylint.pycqa.org/en/latest/) and [black](https://bla
To contribute Python code to this project, please refer to the following installation and usage steps.

### Using Pylint
We run Pylint using [a custom configuration file](.github/linters/.python-lint) against any changed file or directory. See the [Python Github Action workflow](../.github/workflows/python.yml) for details.
We run Pylint using [a custom configuration file](../.github/linters/.python-lint) against any changed file or directory. See the [Python Github Action workflow](../.github/workflows/lint-python.yml) for details.

To invoke Pylint yourself, first install it with `pip install pylint`.

Next, run:

```bash
pylint --rcfile=.github/linters/.python-lint path/to/python/file_or_directory
pylint --rcfile=../.github/linters/.python-lint path/to/python/file_or_directory
```

To lint all Python files in the current directory and its subdirectories, run:

```bash
pylint --rcfile=.github/linters/.python-lint .
pylint --rcfile=../.github/linters/.python-lint .
```

### Using Black
We run Black against any changed file or directory. See the [Python Github Action workflow](../.github/workflows/python.yml) for details.
We run Black against any changed file or directory. See the [Python Github Action workflow](../.github/workflows/lint-python.yml) for details.

To invoke Black yourself, first install it with `pip install black`.

Expand Down
Loading