Names should clearly indicate purpose and behavior using appropriate action verbs and descriptive terms. This applies to functions, methods, variables, and classes. Avoid generic or ambiguous names that don't convey the actual functionality.
Names should clearly indicate purpose and behavior using appropriate action verbs and descriptive terms. This applies to functions, methods, variables, and classes. Avoid generic or ambiguous names that don’t convey the actual functionality.
Key guidelines:
Example of good naming:
# Better names that clearly indicate purpose
def sync_to_local_dir(self, bucket_name: str): # vs generic "download_s3"
def add_debug_span(func): # vs ambiguous "add_span"
# Consistent naming pattern for related properties
class ViewResponse(BaseModel):
icon: str | None = None
icon_dark_mode: str | None = None # vs disconnected "dark_mode_icon"
# Avoid shadowing in loops
for progress_line in progress_callback_lines: # vs reusing "line"
process(progress_line)
Enter the URL of a public GitHub repository