Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing docstrings #714

Merged
merged 4 commits into from
Oct 16, 2023
Merged

Fixing docstrings #714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1f1e7f2
adding descriptions for `constant` factory.
weinbe58 Oct 16, 2023
aff2d64
adding doc string for rydberg constant
weinbe58 Oct 16, 2023
6c10741
adding doc string for `RB_C6`
weinbe58 Oct 16, 2023
e6a8e5d
Merge branch 'main' into fixing-docstrings
weinbe58 Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/bloqade/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"""
10 changes: 5 additions & 5 deletions src/bloqade/factory.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading