From 368032010f06dec46a59f3fd7fb3720c07f53c69 Mon Sep 17 00:00:00 2001 From: "Joseph W. Abbott" Date: Tue, 10 Dec 2024 12:21:53 +0100 Subject: [PATCH] Update _density_correlations.py module docstring --- .../featomic/clebsch_gordan/_density_correlations.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/python/featomic/featomic/clebsch_gordan/_density_correlations.py b/python/featomic/featomic/clebsch_gordan/_density_correlations.py index c1def2ac6..0fa7f0a9e 100644 --- a/python/featomic/featomic/clebsch_gordan/_density_correlations.py +++ b/python/featomic/featomic/clebsch_gordan/_density_correlations.py @@ -1,9 +1,10 @@ """ -This module provides convenience calculators for preforming density correlations, i.e. -the (iterative) CG tensor products of density (body order 2) tensors. +This module provides a convenience calculator for performing density auto- +correlations, i.e. the (iterative) CG tensor products of density (body +order 2) tensors. -All of these calculators wrap the :py:class:`ClebschGordanProduct` class, handling the -higher-level metadata manipulation to produce the desired output tensors. +This wraps the :py:class:`ClebschGordanProduct` class, handling the higher-level +metadata manipulation to produce the desired output tensors. """ from typing import List, Optional