From 805530fe2934a55dc399f80615725157dec5f062 Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Mon, 14 May 2018 09:16:37 -0700 Subject: [PATCH] Update debug-statements description --- .pre-commit-hooks.yaml | 2 +- README.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index 7718810..1f62b3d 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -134,7 +134,7 @@ minimum_pre_commit_version: 0.15.0 - id: debug-statements name: Debug Statements (Python) - description: This hook checks that debug statements (pdb, ipdb, pudb) are not imported on commit. + description: Check for debugger imports and py37+ `breakpoint()` calls in python source. entry: debug-statement-hook language: python types: [python] diff --git a/README.md b/README.md index eaf8d3e..343ebcd 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,8 @@ Add this to your `.pre-commit-config.yaml` otherwise be forbidden. Using this option removes all guarantees of portability to other yaml implementations. Implies `--allow-multiple-documents`. -- `debug-statements` - Check for pdb / ipdb / pudb statements in code. +- `debug-statements` - Check for debugger imports and py37+ `breakpoint()` + calls in python source. - `detect-aws-credentials` - Checks for the existence of AWS secrets that you have set up with the AWS CLI. The following arguments are available: