Use clear, self-documenting names for variables, methods, and classes that express intent without exposing unnecessary implementation details. **For methods and variables:**
Use clear, self-documenting names for variables, methods, and classes that express intent without exposing unnecessary implementation details.
For methods and variables:
connection
instead of conn
, source_location
instead of line
)allowed_redirect_hosts
instead of redirect_hosts_allowed
)compute_checksum
instead of compute_checksum_in_chunks
)For error classes:
ChecksumUnsupportedError
instead of UnsupportedChecksumError
)MissingRequiredOrderError
instead of OrderError
)AssociationNotFoundError
for consistency with HasManyThroughAssociationNotFoundError
)For method signatures:
supports_disabling_use_of_index_for_queries?
when supports_disabling_indexes?
would sufficeRemember that code is read far more often than it’s written. Thoughtful naming reduces cognitive load for future readers.
Enter the URL of a public GitHub repository