From 09654bc9022f72ea834f5c6713b5d2c82ea5ca36 Mon Sep 17 00:00:00 2001 From: Dani Alcala <112832187+clavedeluna@users.noreply.github.com> Date: Tue, 2 Jan 2024 17:09:55 -0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Dan D'Avella --- src/codemodder/scripts/generate_docs.py | 2 +- .../docs/pixee_python_remove-debug-breakpoint.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/codemodder/scripts/generate_docs.py b/src/codemodder/scripts/generate_docs.py index 4cdc11b57..bb7695415 100644 --- a/src/codemodder/scripts/generate_docs.py +++ b/src/codemodder/scripts/generate_docs.py @@ -180,7 +180,7 @@ class DocMetadata: ), "remove-debug-breakpoint": DocMetadata( importance="Medium", - guidance_explained="Breakpoints are used for development debugging and can easily be forgotten before deploying code.", + guidance_explained="Breakpoints are generally used only for debugging and can easily be forgotten before deploying code.", ), } diff --git a/src/core_codemods/docs/pixee_python_remove-debug-breakpoint.md b/src/core_codemods/docs/pixee_python_remove-debug-breakpoint.md index a4d06e339..38fedd7fa 100644 --- a/src/core_codemods/docs/pixee_python_remove-debug-breakpoint.md +++ b/src/core_codemods/docs/pixee_python_remove-debug-breakpoint.md @@ -1,4 +1,6 @@ -This codemod removes any calls to `breakpoint()` or `pdb.set_trace()` which should only be used for active debugging and not in production code. +This codemod removes any calls to `breakpoint()` or `pdb.set_trace()` which are generally only used for interactive debugging and should not be deployed in production code. + +In most cases if these calls are included in committed code, they were left there by mistake and indicate a potential problem. ```diff print("hello")