add missing argument documentation (#331)

qiskit-community · Oct 16, 2024 · 1fd3bcc · 1fd3bcc
1 parent 6253202
commit 1fd3bcc
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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.