Back to all reviewers

Consistent variable naming

tensorflow/tensorflow
Based on 2 comments
Shell

Use ALL_CAPS for constants and environment variables in shell scripts, and reference these variables consistently throughout the script with proper quoting. This improves code readability and prevents errors when handling paths with spaces.

Naming Conventions Shell

Reviewer Prompt

Use ALL_CAPS for constants and environment variables in shell scripts, and reference these variables consistently throughout the script with proper quoting. This improves code readability and prevents errors when handling paths with spaces.

Example:

# Correct
OUTPUT_FILE=tf_env.txt
PYTHON_BIN_PATH="$(which python || which python3 || die "Cannot find Python binary")"

# Then reference consistently
"${PYTHON_BIN_PATH}" -c 'import sys; print(sys.version_info[:])'

# Incorrect
python_bin_path=$(which python || which python3 || die "Cannot find Python binary")
python -c 'import sys; print(sys.version_info[:])'  # Inconsistent reference

Using a consistent naming convention makes scripts more maintainable and helps other developers understand which values are constants. Double-quoting variables (like "${PYTHON_BIN_PATH}") ensures that paths with spaces are handled correctly.

2
Comments Analyzed
Shell
Primary Language
Naming Conventions
Category

Source Discussions