Fixing docstrings (#714)

* adding descriptions for `constant` factory. * adding doc string for rydberg constant * adding doc string for `RB_C6`
QuEraComputing · Oct 16, 2023 · 8851108 · 8851108
1 parent e346c8a
commit 8851108
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/bloqade/constants.py b/src/bloqade/constants.py
@@ -1,3 +1,5 @@
 from math import pi
 
 RB_C6 = 2 * pi * 862690
+"""The C6 constant for the Rydberg Interaction of two Rubidium atoms in units of:
+rad μm^6/μs"""
diff --git a/src/bloqade/factory.py b/src/bloqade/factory.py
@@ -10,9 +10,9 @@ def linear(duration: ScalarType, start: ScalarType, stop: ScalarType) -> Linear:
     """Create a Linear waveform.
 
     Args:
-        duration (ScalarType): duration of linear waveform
-        start (ScalarType): starting value of linear waveform
-        stop (ScalarType): ending value of linear waveform
+        duration (ScalarType): Duration of linear waveform
+        start (ScalarType): Starting value of linear waveform
+        stop (ScalarType): Ending value of linear waveform
 
     Returns:
         Linear: Linear waveform
@@ -25,8 +25,8 @@ def constant(duration: ScalarType, value: ScalarType) -> Constant:
     """Create a Constant waveform.
 
     Args:
-        duration (ScalarType): _description_
-        value (ScalarType): _description_
+        duration (ScalarType): Duration of the Constant waveform.
+        value (ScalarType): Value of the Constant waveform.s
 
     Returns:
         Constant: A Constant waveform.