add more info on cross-truncation

jonathf · Dec 11, 2024 · 1d4ce89 · 1d4ce89
1 parent d805835
commit 1d4ce89
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/chaospy/expansion/frontend.py b/chaospy/expansion/frontend.py
@@ -80,7 +80,9 @@ def generate_expansion(
             Use hyperbolic cross truncation scheme to reduce the number of
             terms in expansion. only include terms where the exponents ``K``
             satisfied the equation
-            ``order >= sum(K**(1/cross_truncation))**cross_truncation``.
+            ``order >= sum(K**(1/cross_truncation))**cross_truncation``. Set to
+            ``np.inf`` to include all terms in a tensor product of marinalized
+            expansion. Set to 0, to not include any cross terms.
 
     Returns:
         (numpoly.ndpoly, numpy.ndarray):