-
Notifications
You must be signed in to change notification settings - Fork 118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add matrix representation of gates to docstrings #597
Comments
As a point of discussion for the issue, it would seem to make sense to have the docstrings using the math directive so the matrices render correctly in the docs. |
For reference, look at how gate matrices are written in the PennyLane plugin |
Related: Each gate currently has documentation generated in three separate places, none of which are particularly useful in terms of telling what the gate or its parameters do. For example,
Arguably the 3rd one is what users would look up first (if they are calling the gate methods via the Maybe this should be a separate issue (I'm happy to create a new issue if desired, just let me know) but I wanted to mention it. |
Closing the issue, since the PR addressing the issue was merged: #756 |
What did you find confusing? Please describe.
The documentation for the supported gates don't sufficiently describe the action of these gates or how each of the parameters are used.
Describe how documentation can be improved
The docstring for each gate implemented here should show the matrix representation of the gate.
Additional context
The text was updated successfully, but these errors were encountered: