Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Dan D'Avella <[email protected]>
  • Loading branch information
clavedeluna and drdavella committed Jan 4, 2024
1 parent b20e292 commit d6ead2a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/codemodder/scripts/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,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.",
),
}

Expand Down
Original file line number Diff line number Diff line change
@@ -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")
Expand Down

0 comments on commit d6ead2a

Please sign in to comment.