Names should clearly communicate their actual behavior and preserve sufficient context for meaningful identification. For functions with conditional behavior, use descriptive suffixes like `_if_needed` or `_maybe` to indicate optionality. For paths and identifiers, maintain enough context to ensure usability - avoid over-shortening that removes essential...
Names should clearly communicate their actual behavior and preserve sufficient context for meaningful identification. For functions with conditional behavior, use descriptive suffixes like _if_needed
or _maybe
to indicate optionality. For paths and identifiers, maintain enough context to ensure usability - avoid over-shortening that removes essential information.
Examples:
wait_for_indexing()
for conditional waiting, use wait_for_indexing_if_needed()
/home/user/work/dir1/file.ext
to just file.ext
, preserve context as dir1/file.ext
This ensures that names serve as clear documentation of intent and maintain practical usability for developers and tools.
Enter the URL of a public GitHub repository