Write informative, consistent, and precise code comments throughout your codebase. When documenting code: 1. **Be specific with references** - When referencing external repositories or sources, link to specific versions and files, not just directories. Use precise language to describe the relationship between your code and external sources.
Write informative, consistent, and precise code comments throughout your codebase. When documenting code:
# AVOID:
# Content below is extracted from scripts/Dockerfiles here:
# https://github.com/HabanaAI/Setup_and_Install/tree/main/dockerfiles/base
# BETTER:
# Content below is based on:
# https://github.com/HabanaAI/Setup_and_Install/blob/1.17.0/dockerfiles/base/Dockerfile.ubuntu22.04
# AVOID:
RUN python3 -m pip install habana_media_loader=="${VERSION}"."${REVISION}"
# BETTER:
# Install Habana media loader library for PyTorch integration
RUN python3 -m pip install habana_media_loader=="${VERSION}"."${REVISION}"
# AVOID mixing styles:
# version details
# and elsewhere:
# args - software versions
# BETTER: Use consistent headers:
# args - software versions
Well-documented code improves comprehension, facilitates maintenance, and enhances collaboration among team members.
Enter the URL of a public GitHub repository