initial docstring improvement

[arsalan-motamedi]

Context:
Docstrings miss things.

Description of the Change:
Improving docstrings (initial attempt).

Benefits:
Clear

Possible Drawbacks:
None.

Related GitHub Issues:
None.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.55%. Comparing base (1d414cc) to head (2e57290).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #551      +/-   ##
===========================================
+ Coverage    90.52%   90.55%   +0.03%     
===========================================
  Files          102      102              
  Lines         6186     6186              
===========================================
+ Hits          5600     5602       +2     
+ Misses         586      584       -2     

Files with missing lines	Coverage Δ
...ustard/lab_dev/circuit_components_utils/b_to_ps.py	100.00% <ø> (ø)
...mustard/lab_dev/circuit_components_utils/b_to_q.py	100.00% <ø> (ø)
...tard/lab_dev/circuit_components_utils/trace_out.py	100.00% <ø> (ø)
mrmustard/lab_dev/states/bargmann_eigenstate.py	100.00% <ø> (ø)
mrmustard/lab_dev/states/base.py	96.66% <ø> (ø)
mrmustard/lab_dev/states/coherent.py	100.00% <ø> (ø)
mrmustard/lab_dev/states/displaced_squeezed.py	100.00% <ø> (ø)
mrmustard/lab_dev/states/dm.py	95.65% <100.00%> (ø)
mrmustard/lab_dev/states/gaussian_state.py	100.00% <ø> (ø)
mrmustard/lab_dev/states/ket.py	98.51% <100.00%> (ø)
... and 5 more

... and 1 file with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

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

[Ganar-lab]

Hey Arsalan, I spotted that the signature and docstring of this function is incorrect: link

def vacuum_means(num_modes: int) -> tuple[Matrix, Vector]:
    r"""Returns the real covariance matrix and real means vector of the vacuum state.

    Args:
        num_modes (int): number of modes

    Returns:
        Matrix, Vector: thermal state covariance matrix or means vector
    """
    return displacement(
        math.zeros(num_modes, dtype="float64"),
        math.zeros(num_modes, dtype="float64"),
    )

It only returns the means vector of the vacuum. Also, not of a thermal state.

[arsalan-motamedi]

Hey Arsalan, I spotted that the signature and docstring of this function is incorrect: link

def vacuum_means(num_modes: int) -> tuple[Matrix, Vector]:
    r"""Returns the real covariance matrix and real means vector of the vacuum state.

    Args:
        num_modes (int): number of modes

    Returns:
        Matrix, Vector: thermal state covariance matrix or means vector
    """
    return displacement(
        math.zeros(num_modes, dtype="float64"),
        math.zeros(num_modes, dtype="float64"),
    )

It only returns the means vector of the vacuum. Also, not of a thermal state.

Great catch! Thanks.