[DOC-935]Correct the RampPulse formula in description

Qingzhen Wangrequested to merge
ramp_pulse_formula_correction into main

Explanation of changes

DOC-935: the original formula is wrong and it leads to confusion of whether the given amp as a kwarg is a step-amp or the total amp. You may have also seen another MR for quantify-scheduler but the content is exactly the same.

Motivation of changes

Motivate why the particular solution was chosen.

Merge checklist

  • Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer.
  • New code is covered by unit tests (or N/A).
  • New code is documented and docstrings use numpydoc format (or N/A).
  • New functionality: considered making private instead of extending public API (or N/A).
  • Newly added/adjusted documentation and docstrings render properly (or N/A).
  • Tested on hardware (or N/A).
  • CHANGELOG.md for breaking changes and AUTHORS.md have been updated (or N/A).
  • Update Hardware backends documentation if backend interface change or N/A
  • Check whether performance is significantly affected by looking at the Performance metrics results.
  • New files start with the following copyright header:
# Repository: https://gitlab.com/qblox/packages/software/qblox_scheduler
# Licensed according to the LICENSE file on the main branch
#
# Copyright <YEAR>, Qblox B.V.
  • Windows tests in CI pipeline pass (manually triggered by maintainers before merging).
    • Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline

Merge request reports