vprusso/toqito

Add more details to module level docstrings

Opened this issue · 0 comments

purva-thakre commented

Due to the changes introduced in #448 and #440, the docstrings at the top of a .py file will appear in the documentation. Most of these docstrings lack details.

For example,

image

toqito/toqito/states/werner.py

Line 1 in 48fbde1

"""Werner state."""

This also affects the docstring in init files.

image

toqito/toqito/states/__init__.py

Line 1 in 48fbde1

"""Quantum states."""

This issue is to add more details to each of the following modules:

  • Add details to the module level docstrings: toqito/channel_metrics
  • Add details to the module level docstrings: toqito/channel_ops
  • Add details to the module level docstrings: toqito/channel_props
  • Add details to the module level docstrings: toqito/channels
  • Add details to the module level docstrings: toqito/helper
  • Add details to the module level docstrings: toqito/matrices
  • Add details to the module level docstrings: toqito/matrix_ops
  • Add details to the module level docstrings: toqito/matrix_props
  • Add details to the module level docstrings: toqito/measurement_ops
  • Add details to the module level docstrings: toqito/measurement_props
  • Add details to the module level docstrings: toqito/nonlocal_games
  • Add details to the module level docstrings: toqito/perms
  • Add details to the module level docstrings: toqito/rand
  • Add details to the module level docstrings: toqito/state_metrics
  • Add details to the module level docstrings: toqito/state_ops
  • Add details to the module level docstrings: toqito/state_opt
  • Add details to the module level docstrings: toqito/state_props
  • Add details to the module level docstrings: toqito/states