P.808 copilot-instructions.md

Copilot Instructions

Code Style and Formatting

Function Documentation

Python

Every function must include a docstring inside the function body, immediately after the def line. Use the following format:

def calculate_mos(ratings, num_subjects):
    """
    Calculate the Mean Opinion Score from a list of ratings.

    :param ratings: List of numeric ratings.
    :param num_subjects: Number of subjects who provided ratings.
    :return: The computed MOS value as a float.
    """
    ...

JavaScript

Every function must have a JSDoc comment above the function declaration:

/**
 * Calculate the Mean Opinion Score from a list of ratings.
 *
 * @param {number[]} ratings - List of numeric ratings.
 * @param {number} numSubjects - Number of subjects who provided ratings.
 * @returns {number} The computed MOS value.
 */
function calculateMos(ratings, numSubjects) {
    ...
}

Python Spacing and Syntax

Follow PEP 8 conventions:

• Use 4 spaces per indentation level. Do not use tabs.
• Surround top-level function and class definitions with two blank lines.
• Surround method definitions inside a class with one blank line.
• Use spaces around operators (=, +=, ==, !=, <, >, in, not in, etc.).
• No spaces immediately inside parentheses, brackets, or braces:
  • ✅ func(a, b) — ❌ func( a, b )
  • ✅ data[0] — ❌ data[ 0 ]
  • ✅ {'key': value} — ❌ { 'key' : value }
• Place one space after commas in argument lists, collections, and imports.
• No trailing whitespace on any line.
• Keep lines to a maximum of 120 characters.
• Use snake_case for functions and variables, PascalCase for classes, and UPPER_SNAKE_CASE for constants.
• Imports should be grouped in the following order, separated by a blank line:
  1. Standard library imports
  2. Third-party imports
  3. Local / project imports

Line Endings