Fix docstring of gates.PRX
#1571
Conversation
renatomello
requested review from
alecandido,
BrunoLiegiBastonLiegi and
MatteoRobbiati
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1571 +/- ##
=======================================
Coverage 99.66% 99.66%
=======================================
Files 76 76
Lines 11440 11440
=======================================
Hits 11402 11402
Misses 38 38
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| .. math:: | ||
| \\begin{pmatrix} | ||
| \\cos{(\\theta / 2)} & -i e^{-i \\phi} \\sin{(\\theta / 2)} \\\\ | ||
| -i e^{i \\phi} \\sin{(\\theta / 2)} & \\cos{(\\theta / 2)} | ||
| \\end{pmatrix} |
There was a problem hiding this comment.
To save a few \, you can put an r in front of the docstring's opening quotes, i.e. r""" (r for raw). This will deactivate escape codes, so \n won't be any longer a newline, and \t is not a tab (but they will be literally interpreted as the two characters you typed). However, that's usually what you want in a docstring.
https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals
It will allow you to use a single \, and just write \begin, and so on.
You may have been already aware. In case you chose explicitly, sorry for the extra noise.
Checklist: