-
Notifications
You must be signed in to change notification settings - Fork 330
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update references to Terra's classes in docstrings #474
Comments
@adekusar-drl Can you explain what is to be done here in HTML Documentation |
The point is to update docstrings across the module in a way that references to classes/methods/etc become clickable in the HTML documentation. For example, in the
In the html documentation available here |
For example, to create a clickable link to the ZZFeatureMap class in the qiskit.circuit.library module, you would format the text in your docstring as follows right |
Yes, this is correct. |
I Guess I Can try to work on this 3 issues The SVR and this one while waiting for Terra release |
Ok, I assigned this issue to you as well. But if you don't have time to work on any of them, let me know. |
Yes I will try to and keep you updated |
@AbdullahKazi500 is there any progress here? |
Hi @adekusar-drl I am working to Replace the existing plain text reference with the cross-reference format in each docstring. |
Is there something else that is yet to be completed in this issue? |
Considering the lack of progress and the time passed since the last message, I think, it is an issue that anybody can give a try. |
Closed as done by #700 |
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 inqiskit.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.The text was updated successfully, but these errors were encountered: