Skip to content

Simplify audit_in_ci help text in copier.yml#33

Merged
tsvikas merged 1 commit into
mainfrom
claude/reduce-pip-audit-verbosity-pMYHp
May 15, 2026
Merged

Simplify audit_in_ci help text in copier.yml#33
tsvikas merged 1 commit into
mainfrom
claude/reduce-pip-audit-verbosity-pMYHp

Conversation

@tsvikas
Copy link
Copy Markdown
Owner

@tsvikas tsvikas commented May 15, 2026

Summary

Simplified and clarified the help text for the audit_in_ci configuration option in copier.yml to be more concise while retaining the essential information.

Changes

  • Condensed the multi-line help text from 5 lines to 2 lines
  • Removed redundant explanation about downstream consumers and dependency resolution
  • Kept the core message: pip-audit runs on locked dependencies in weekly CI
  • Maintained reference to alternative audit methods (Dependabot and just deps-audit)

Details

The original help text was verbose and included context about how downstream consumers resolve their own dependencies. The updated version conveys the same essential information more concisely, making it easier to read while still explaining the purpose and available alternatives.

https://claude.ai/code/session_01QLH38Am27efEsDegHfk2Cg

The previous help text spanned five lines, making the copier
questionnaire feel verbose at that step. Trim to a single concise line
matching the style of the surrounding prompts.
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Consider spelling out "dependencies" instead of "deps" in the help text to avoid potential confusion for users less familiar with the shorthand.
  • The original text clarified that the audit primarily affects developers/CI rather than downstream consumers; if that distinction is still important for decision-making, it might be worth keeping a brief version of that nuance in the simplified wording.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider spelling out "dependencies" instead of "deps" in the help text to avoid potential confusion for users less familiar with the shorthand.
- The original text clarified that the audit primarily affects developers/CI rather than downstream consumers; if that distinction is still important for decision-making, it might be worth keeping a brief version of that nuance in the simplified wording.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@tsvikas tsvikas merged commit 5e629a6 into main May 15, 2026
5 checks passed
@tsvikas tsvikas deleted the claude/reduce-pip-audit-verbosity-pMYHp branch May 15, 2026 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants