Choose names that precisely reflect the component's purpose and behavior, avoiding ambiguous terms or shortcuts. Names should be self-documenting and consistent with related components.
Choose names that precisely reflect the component’s purpose and behavior, avoiding ambiguous terms or shortcuts. Names should be self-documenting and consistent with related components.
Key guidelines:
Example:
# Incorrect - ambiguous or imprecise names
class JSONGenerator:
def generate(self, data: dict) -> dict:
pass
meta_collection = db.get_collection("meta")
def noop_loader(doc: dict) -> dict:
return doc
# Correct - precise, semantic names
class SchematicGenerator:
def generate(self, data: dict) -> dict:
pass
metadata_collection = db.get_collection("metadata")
def identity_loader(doc: dict) -> dict:
return doc
Enter the URL of a public GitHub repository