Update documentation #312
Update documentation #312
Conversation
thisac
requested review from
josh146 and
sduquemesa
and removed request for
sduquemesa
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.
Should we simply import the labudde functions top level?
| @@ -15,13 +15,16 @@ | |||
| Fock gradients of Gaussian gates | |||
| ================================ | |||
|
|
|||
| **Module name:** :mod:`thewalrus.fock_gradients` | |||
There was a problem hiding this comment.
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.
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.