search

quantumlib / Qualtran

Qᴜᴀʟᴛʀᴀɴ is a Python library for expressing and analyzing Fault Tolerant Quantum algorithms.
https://qualtran.readthedocs.io/en/latest/
Apache License 2.0
134 stars 35 forks source link

Capture docs from abstract base classes? #980

Closed fdmalone closed 1 month ago

fdmalone commented 2 months ago

SelectOracle / PrepareOracle / BlockEncoding / ... potentially more bloqs have docs which aren't captured anywhere which could be helpful for developers. Should they be captured?

mpharrigan commented 2 months ago

Have you tried adding a BloqDocSpec without any bloq examples? it will pull in / render the docstrings which I assume is the extent of the documentation you were imagining

fdmalone commented 1 month ago

This already worked as per #988 and #967