Back to all reviewers

Use descriptive names

comfyanonymous/ComfyUI
Based on 6 comments
Python

Choose descriptive, self-documenting names for constants, functions, parameters, and types that clearly communicate their purpose and meaning. Avoid magic numbers, generic strings, and ambiguous identifiers that require additional context to understand.

Naming Conventions Python

Reviewer Prompt

Choose descriptive, self-documenting names for constants, functions, parameters, and types that clearly communicate their purpose and meaning. Avoid magic numbers, generic strings, and ambiguous identifiers that require additional context to understand.

Replace magic values with named constants:

# Instead of:
win32event.WaitForSingleObject(hProcess, 10 * 1000)

# Use:
TEN_SECONDS_MS = 10 * 1000
win32event.WaitForSingleObject(hProcess, TEN_SECONDS_MS)

Use semantic constants instead of magic strings:

# Instead of:
{"source": ("*", {})}

# Use:
{"source": (node_typing.IO.ANY, {})}

Choose accurate function names that reflect their actual behavior:

# Instead of:
def init_builtin_custom_nodes():

# Use:
def init_builtin_extra_nodes():

Use specific type annotations that communicate intent:

# Instead of:
def filter_files_content_types(files: List[str], content_types: List[str]) -> List[str]:

# Use:
def filter_files_content_types(files: List[str], content_types: Literal["image", "video", "audio"]) -> List[str]:

This practice makes code self-documenting, reduces the need for comments, and helps prevent misunderstandings about the code’s purpose and behavior.

6
Comments Analyzed
Python
Primary Language
Naming Conventions
Category

Source Discussions