From 1fd3bcc449a5a4dff77979a31f040105f0d27127 Mon Sep 17 00:00:00 2001 From: "Kevin J. Sung" Date: Wed, 16 Oct 2024 14:37:26 -0400 Subject: [PATCH] add missing argument documentation (#331) --- python/ffsim/variational/ucj_spin_balanced.py | 1 + python/ffsim/variational/ucj_spin_unbalanced.py | 1 + python/ffsim/variational/ucj_spinless.py | 1 + 3 files changed, 3 insertions(+) diff --git a/python/ffsim/variational/ucj_spin_balanced.py b/python/ffsim/variational/ucj_spin_balanced.py index 0505c9135..bcdd2c9ec 100644 --- a/python/ffsim/variational/ucj_spin_balanced.py +++ b/python/ffsim/variational/ucj_spin_balanced.py @@ -166,6 +166,7 @@ def n_params( r"""Return the number of parameters of an ansatz with given settings. Args: + norb: The number of spatial orbitals. n_reps: The number of ansatz repetitions. interaction_pairs: Optional restrictions on allowed orbital interactions for the diagonal Coulomb operators. diff --git a/python/ffsim/variational/ucj_spin_unbalanced.py b/python/ffsim/variational/ucj_spin_unbalanced.py index 13aa17ae5..4c4fd2e2a 100644 --- a/python/ffsim/variational/ucj_spin_unbalanced.py +++ b/python/ffsim/variational/ucj_spin_unbalanced.py @@ -175,6 +175,7 @@ def n_params( r"""Return the number of parameters of an ansatz with given settings. Args: + norb: The number of spatial orbitals. n_reps: The number of ansatz repetitions. interaction_pairs: Optional restrictions on allowed orbital interactions for the diagonal Coulomb operators. diff --git a/python/ffsim/variational/ucj_spinless.py b/python/ffsim/variational/ucj_spinless.py index 4e36fd9b9..472a608ab 100644 --- a/python/ffsim/variational/ucj_spinless.py +++ b/python/ffsim/variational/ucj_spinless.py @@ -151,6 +151,7 @@ def n_params( r"""Return the number of parameters of an ansatz with given settings. Args: + norb: The number of spatial orbitals. n_reps: The number of ansatz repetitions. interaction_pairs: Optional restrictions on allowed orbital interactions for the diagonal Coulomb operators.