Skip to content
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

Add missing Circuit methods to API docs #1352

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Apr 17, 2024

Description

Adding some more Circuit methods that were left out of the API docs.

['add_circbox_regwise', 'AAMS', 'GPI', 'add_circbox_with_regmap', 'GPI2', 'add_termsequencebox']

These were found using the check_circuit_class_docs.py. script. Unfortunately haven't been able to get the sphinx coverage extension to work reliably to check all of the docs.

Related issues

Please mention any github issues addressed by this PR.

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

@CalMacCQ CalMacCQ requested a review from cqc-alec April 17, 2024 08:27
@CalMacCQ CalMacCQ changed the title add yet more missing circuit methods Add missing Circuit methods to API docs Apr 17, 2024

.. automethod:: GPI

.. automethod:: GPI2
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't have to be in this PR, but maybe these should be in alphabetical order to make them easier to find?

Copy link
Contributor Author

@CalMacCQ CalMacCQ Apr 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order I opted for was to have similar gates grouped together rather than alphabetical

e.g.

   .. automethod:: CRy

   .. automethod:: CRz

   .. automethod:: CU1

   .. automethod:: CU3

Alphabetical ordering would mean that Circuit.AAMS would be at the top and the more commonly used Circuit.Z would be at the bottom.

Maybe alphabetical is better, not sure.

@CalMacCQ CalMacCQ merged commit 25d0a60 into develop Apr 17, 2024
28 checks passed
@CalMacCQ CalMacCQ deleted the docs/missing_circuit_methods branch April 17, 2024 08:49
@CalMacCQ CalMacCQ added the documentation Improvements or additions to documentation label Apr 17, 2024
CalMacCQ added a commit that referenced this pull request Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants