Prompt
Choose names that clearly convey purpose and intent rather than generic or ambiguous terms. Prefer specific, descriptive terminology that makes code self-documenting and reduces cognitive load for readers.
Key principles:
- Use precise terminology: prefer “excerpt” or “snippet” over “extract”, “find” over “get” for search operations
- Choose descriptive parameter names:
file_readeris more precise thancontent_readerwhen the function reads entire files - Import modules for semantic clarity:
charset_normalizer.from_pathis more meaningful than a barefrom_pathimport - Use specific types with semantic meaning:
IntEnumwith named values instead of rawintfor severity levels
Example improvements:
# Less clear
from charset_normalizer import from_path
def get_extracts(content_reader: Callable[[str], str]):
severity: int = 1
# More semantically meaningful
import charset_normalizer
def find_code_snippets(file_reader: Callable[[str], str]):
severity: DiagnosticSeverity = DiagnosticSeverity.ERROR
result = charset_normalizer.from_path(path)
This approach makes code more maintainable by reducing ambiguity and making the developer’s intent explicit through careful name selection.