qiskit-machine-learning icon indicating copy to clipboard operation
qiskit-machine-learning copied to clipboard

Update references to Terra's classes in docstrings

Open adekusar-drl opened this issue 3 years ago • 0 comments

What is the expected enhancement?

Review all docstrings in the package and update references to Terra's classes. For instance, in the VQC documentation we reference ``ZZFeatureMap`` that is in qiskit.circuit.library. When the package documentation is generated, the reference becomes just a plain text. Such references should be replaced with cross references, that are replaced in the generated documentations with corresponding links. In this example, in the documentation ``ZZFeatureMap`` to be replaced with `:class:`~qiskit.circuit.library.ZZFeatureMap`. Then in the html documentation this cross reference will become a link to the corresponding class in Terra.

adekusar-drl avatar Sep 23 '22 11:09 adekusar-drl