cspell.json

// This configuration file sets options for spell-checking pull requests
// onto this repository. Please see
//     https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell#cspelljson
// for more documentation about this config file.
{
    // Use a file-matching pattern to identify Q# source files when running
    // in CI (that is, when VS Code doesn't provide the language ID for
    // Q#).
    "overrides": [
        {
            "languageId": "qsharp",
            "filename": "**/*.qs"
        }
    ],

    // Define keywords on a per-language basis.
    "languageSettings": [
        {
            "languageId": ["qsharp"],
            // cspell:disable
            "ignoreWords": [
                "newtype",
                "elif"
            ]
            // cspell:enable
        }
    ],

    "ignoreWords": [
        // Q# terminology
        "iqsharp",

        // # .NET terminology
        "xunit",

        // # Jupyter terminology
        "ipynb",
        "jupytext",
        "endregion",
        "kernelspec",
        "nteract",

        // # Python terminology
        "conda",
        "matplotlib",
        "xlabel", // Used in matplotlib calls.
        "ylabel",

        // # Terms that come up in build / CI configuration
        "logissue", // Used in ##[vso.logissue] commands.
        "pwsh",
        "markdownlint",

        // # Words, terms, and names specific to quantum computing
        "CHSH",
        "CNOT",
        "Chuang",
        "eigenstate",
        "kata",
        "qsharp",
        "qubit",
        "qubits",
        "qubit's",
        "qubitization",
        "qubitized",
        "wavefunction",
        "Hadamard",
        "TCNOT",
        "ctrls",

        // # Mathematics terminology
        "binom", // Common shorthand for "binomial."
        "coeff", // Common shorthand for "coefficient."
        "coeffs",
        "eigen",
        "eigensystem",
        "sqrtm", // Common shorthand for "matrix square root," popularized by
                 // MATLAB and SciPy.
        "renormalizing",
        "unnormalized",

        // # Physics terminology
        "Ising",
        "elementwise",

        // # Chemistry terminology
        "fermionic",
        "nitrogenase",
        "Hartree",
        "Fock",
        "nwchem",

        // # Other terminology
        // NB: before adding terms here, please add a comment explaining
        //     where each term is used.
        "Remez", // As in Remez's algorithm (https://en.wikipedia.org/wiki/Remez_algorithm).
        "Remez's",
        "Chebyshev", // As in Chebyshev polynomials.
        "Shor", // As in Shor's algorithm
        "Shor's", // As in Shor's algorithm
        "Welford's", // Algorithm for learning mean and variances of streaming
        // data.

        // # Package and provider names
        "ionq",
        "apival",
        "cirq",
        "qiskit"
        "quantinuum"
    ],
    // By definition, everything in flagWords is considered to be spelled
    // wrong. Thus we disable spell checking for the list of misspelled words...
    // cspell:disable
    "flagWords": [
        // The Trotter–Suzuki decomposition isn't a verb.
        "Trotterization"
    ]
    // cspell:enable
}