Skip to content

Commit

Permalink
Improve envelopes' docstrings
Browse files Browse the repository at this point in the history
Co-authored-by: Hayk Sargsyan <[email protected]>
  • Loading branch information
alecandido and hay-k committed Jun 25, 2024
1 parent 34dba9e commit 33b733d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/qibolab/pulses/envelope.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Library of pulse shapes."""
"""Library of pulse envelopes."""

from abc import ABC
from typing import Annotated, Literal, Union
Expand Down Expand Up @@ -131,7 +131,7 @@ def i(self, samples: int) -> Waveform:


class GaussianSquare(BaseEnvelope):
r"""GaussianSquare pulse shape.
r"""Rectangular envelope with Gaussian rise and fall.
.. math::
Expand Down Expand Up @@ -161,7 +161,7 @@ def i(self, samples: int) -> Waveform:


class Drag(BaseEnvelope):
"""Derivative Removal by Adiabatic Gate (DRAG) pulse shape.
"""Derivative Removal by Adiabatic Gate (DRAG) pulse envelope.
.. todo::
Expand Down Expand Up @@ -267,7 +267,7 @@ def i(self, samples: int) -> Waveform:


class ECap(BaseEnvelope):
r"""ECap pulse shape.
r"""ECap pulse envelope.
.. todo::
Expand Down Expand Up @@ -296,7 +296,7 @@ def i(self, samples: int) -> Waveform:


class Custom(BaseEnvelope):
"""Arbitrary shape.
"""Arbitrary envelope.
.. todo::
Expand Down

0 comments on commit 33b733d

Please sign in to comment.