search

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
344 stars 145 forks source link

API-doc has run-on sentences #2422

Open purva-thakre opened 4 days ago

purva-thakre commented 4 days ago

As we rely on google-style docstrings, there is no convention to allow lists in the description of the different sections of a docstring. Portions of our API-doc have run-on sentences because someone used a list in the section description which appears as badly formatted sentences publicly.

Intended in API-doc
image image
purva-thakre commented 4 days ago

@natestemen Is this what you were referring to?

natestemen commented 4 days ago

Not really. I was thinking we could take inspiration from how numpy documents kwargs objects, but I haven't been able to find what I was looking for. One thing I did find, however, was that for numpy.clip they redirect to a different page for info on what kwargs can look like. Not necessarily suggesting we do that, just worth noting.