Naming Variables

What problem does it solve?

This Skill eliminates cryptic, ambiguous, or generic variable names that make code hard to understand, debug, and maintain. It provides comprehensive principles and conventions to ensure every name accurately and fully describes its purpose, making code self-documenting and intuitive.

Core Features & Use Cases

• Descriptive Naming: Guides you to use names that describe "what" a variable represents in the problem domain, not "how" it's implemented.
• Optimal Length & Scope: Provides guidelines for name length based on variable scope, balancing descriptiveness with conciseness.
• Consistent Conventions: Establishes standards for naming booleans (is_valid), collections (users), constants (MAX_RETRIES), and computed values (revenue_total).
• Use Case: Instead of x = x - xx, this skill guides you to use balance = balance - last_payment, making the code's intent immediately clear. It also helps diagnose design problems when a name is hard to find.

Quick Start

Review the attached Python function. Identify any variables with vague, generic, or misleading names. Suggest improved names following the principles of descriptiveness, optimal length, and consistent conventions.