literals for pydoc

C2QA · Oct 12, 2023 · 815cde0 · 815cde0
1 parent c2fc6f5
commit 815cde0
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/c2qa/circuit.py b/c2qa/circuit.py
@@ -236,8 +236,9 @@ def cv_initialize(self, params, qumodes):
         Args:
             params (list or int): If an int, all specified qumodes will be initialized to the Fock state with n=params.
                                   If a list, all specified qumodes will be initialized to a superposition of Fock states,
-                                  with params[n] the complex amplitude of Fock state |n>. The length of params must be less
+                                  with ``params[n]`` the complex amplitude of Fock state ``|n>``. The length of params must be less
                                   than or equal to the cutoff.
+
             qumodes (list): list of qubits representing a single qumode, or list of multiple qumodes
 
         Raises: