Add comprehensive docstring for get_exchange_kernels_GaussLegendre

[Copilot]

Addresses review feedback requesting complete API documentation for get_exchange_kernels_GaussLegendre.

Changes

• Added NumPy-style docstring with:
  • Parameters: All 9 arguments documented with types and semantics
  • Returns: Explicit numpy.ndarray of numpy.complex128 with shape specification
  • Raises: Specific error conditions including callable shape requirements
  • Notes: Preserved optimization details in proper section format

def get_exchange_kernels_GaussLegendre(
    G_magnitudes,
    G_angles,
    nmax: int,
    *,
    potential: str | callable = "coulomb",
    kappa: float = 1.0,
    nquad: int = 8000,
    scale: float = 0.5,
    ell: float = 1.0,
    sign_magneticfield: int = -1,
) -> "ComplexArray":
    """Compute exchange kernels X_{n1,m1,n2,m2}(G) using Gauss-Legendre quadrature.

    Parameters
    ----------
    G_magnitudes : array_like of float
        Magnitudes |G| of the reciprocal lattice vectors...
    ...

    Returns
    -------
    numpy.ndarray of numpy.complex128
        Exchange kernels with shape ``(nG, nmax, nmax, nmax, nmax)``...
    """

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[Copilot]

Pull request overview

This PR adds comprehensive NumPy-style documentation to the get_exchange_kernels_GaussLegendre function, addressing a review feedback request for complete API documentation. The docstring follows the codebase's established NumPy documentation style with complete parameter descriptions, return value specification, error conditions, and implementation notes.

Key changes:

• Expanded one-line summary to a detailed multi-paragraph description of the function's purpose
• Added complete parameter documentation for all 9 arguments including types, semantics, and default values
• Specified explicit return type (numpy.ndarray of numpy.complex128) with shape information
• Documented three distinct error conditions in the Raises section
• Restructured optimization details into proper Notes section with improved formatting

Comments suppressed due to low confidence (1)

src/quantumhall_matrixelements/exchange_legendre.py:160

• Variable Veff is not used.

        Veff = None

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The docstring states that sign_magneticfield "Must be -1 or +1", but the function does not validate this constraint. The related function get_exchange_kernels_hankel includes explicit validation (if sign_magneticfield not in (1, -1): raise ValueError(...)). Consider either:

1. Adding validation at the start of the function to enforce this constraint, or
2. Softening the language to "Should be -1 or +1" or "Typically -1 or +1"

This ensures consistency between documentation and actual behavior.