Skip to content

Commit

Permalink
Update _density_correlations.py module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
jwa7 authored and Luthaf committed Dec 10, 2024
1 parent e92fb58 commit 3680320
Showing 1 changed file with 5 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 3680320

Please sign in to comment.