Add doc string for width in Rust

jlapeyre · Jun 4, 2024 · 16755cd · 16755cd
1 parent 2ffac76
commit 16755cd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/crates/circuit/src/circuit_data.rs b/crates/circuit/src/circuit_data.rs
@@ -255,6 +255,11 @@ impl CircuitData {
         self.clbits_native.len()
     }
 
+    /// Return the width of the circuit. This is the number of qubits plus the
+    /// number of clbits.
+    ///
+    /// Returns:
+    ///     int: The width of the circuit.
     pub fn width(&self) -> usize {
         self.num_qubits() + self.num_clbits()
     }