search

XanaduAI / strawberryfields

Strawberry Fields is a full-stack Python library for designing, simulating, and optimizing continuous variable (CV) quantum optical circuits.
https://strawberryfields.ai
Apache License 2.0
745 stars 187 forks source link

Updates docstring of MZgate #624

Closed nquesada closed 2 years ago

nquesada commented 2 years ago

Add useful meaningful info for MZgate in its docstring.

codecov[bot] commented 2 years ago

Codecov Report

Merging #624 (4d865d9) into master (717e7a1) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #624   +/-   ##
=======================================
  Coverage   98.54%   98.54%           
=======================================
  Files          77       77           
  Lines        8938     8938           
=======================================
  Hits         8808     8808           
  Misses        130      130
Impacted Files Coverage Δ
strawberryfields/ops.py 98.98% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 717e7a1...4d865d9. Read the comment docs.

nquesada commented 2 years ago

You can see the rendered version of the maths in this link:

https://strawberryfields--624.org.readthedocs.build/en/624/code/api/strawberryfields.ops.MZgate.html?highlight=mzgate#strawberryfields.ops.MZgate

nquesada commented 2 years ago

Thanks @tymomboe !