From 8d74b7f7ff26efb17612cfdc5b4298bd9d824044 Mon Sep 17 00:00:00 2001 From: Alessandro Candido Date: Tue, 16 Apr 2024 10:32:23 +0200 Subject: [PATCH] Improve envelopes' docstrings Co-authored-by: Hayk Sargsyan <52532457+hay-k@users.noreply.github.com> --- src/qibolab/pulses/envelope.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/qibolab/pulses/envelope.py b/src/qibolab/pulses/envelope.py index 85a087fcf0..cda3581bec 100644 --- a/src/qibolab/pulses/envelope.py +++ b/src/qibolab/pulses/envelope.py @@ -1,4 +1,4 @@ -"""Library of pulse shapes.""" +"""Library of pulse envelopes.""" from abc import ABC from typing import Annotated, Literal, Union @@ -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:: @@ -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:: @@ -267,7 +267,7 @@ def i(self, samples: int) -> Waveform: class ECap(BaseEnvelope): - r"""ECap pulse shape. + r"""ECap pulse envelope. .. todo:: @@ -296,7 +296,7 @@ def i(self, samples: int) -> Waveform: class Custom(BaseEnvelope): - """Arbitrary shape. + """Arbitrary envelope. .. todo::