-
Notifications
You must be signed in to change notification settings - Fork 56
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
Update documentation #312
Update documentation #312
Conversation
Codecov Report
@@ Coverage Diff @@
## master #312 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 1561 1568 +7
=========================================
+ Hits 1561 1568 +7
Continue to review full report at Codecov.
|
Co-authored-by: Nicolas Quesada <991946+nquesada@users.noreply.github.com>
docs/code.rst
Outdated
@@ -12,6 +12,10 @@ Python API | |||
|
|||
* The :mod:`thewalrus.symplectic` submodule provides access to a convenient set of symplectic matrices and utility functions to manipulate them | |||
|
|||
* The :mod:`thewalrus.decompositions` submodule provides access to common shared matrix decompositions used to perform gate decompositions | |||
|
|||
* The :mod:`thewalrus.labudde` submodule provides access to La Budde's algorithm to calculate the characteristic polynomials of matrices |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we simply import the labudde functions top level?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Theo! Don't forget to update the changelog
@@ -15,13 +15,16 @@ | |||
Fock gradients of Gaussian gates | |||
================================ | |||
|
|||
**Module name:** :mod:`thewalrus.fock_gradients` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
out-of-scope thought: we should rename this module to simply thewalrus.fock
(although this would be a breaking change for SF).
The reason being, I was helping a user use TW, and both the user and myself completely overlooked this module, as we assumed it only provided gradients! Whereas the focus of this module is more Fock representations (of which gradients are included)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds reasonable, I'd say. 👍
Co-authored-by: Josh Izaac <josh146@gmail.com>
Context:
Some parts of the documentation were not consistent.
Description of the Change:
__init__.py
.