Update comments to Sphinx documentation format close #10 #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Zhaoyilunnn
requested changes
Jul 29, 2024
There was a problem hiding this comment.
Hello @raunakkumarsingh , thanks for the help. Most docstrings look good to me. It would be better to make some additional changes before I merge your PR.
- Sometimes
NP (np)andNL (nl)are illustrated asnumber of partitionsandnumber of layers. However, in qdao, they consistently representnumber of primary qubitsandnumber of local qubits - Please check the docstrings with class attributes, sometimes they are just class members or variables not belong to this class.
- Please check the
qdao/qiskitdirectory, most files are qiskit source code. I put them in qdao since I need to do some tricky changes in qiskit source code to make it work correctly with qdao. For these qiskit codes, I suggest not to change their original docstrings.
|
Please ignore the unit test failing. This is due to qiskit version conflict and I have fixed it 6675a98 |
|
I resolved all issues. Can you confirm if there are any other changes needed? |
Zhaoyilunnn
approved these changes
Aug 5, 2024
Zhaoyilunnn
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.