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

Docs: AQT not included in API documentation #2503

Closed
drewrisinger opened this issue Nov 6, 2019 · 3 comments
Closed

Docs: AQT not included in API documentation #2503

drewrisinger opened this issue Nov 6, 2019 · 3 comments
Assignees

Comments

@drewrisinger
Copy link
Contributor

Not sure if this is intentional or not, but the AQT device is entirely unmentioned in the v0.6 (stable) docs.

This could be fixed with something like sphinx-apidoc if this project uses that.

Related:

  • Several of the functions/classes in the AQT file are either not fully-documented or malformatted.

Examples:

Args:
circuit: Circuit to be run
param_resolver: Param resolver for the
Returns:

def _send_json(self,
*,
json_str: str,
id_str: Union[str, uuid.UUID],
repetitions: int = 1,
num_qubits: int = 1):
"""Sends the json string to the remote AQT device
Args:

@Strilanc
Copy link
Contributor

Thanks for the report.

We need to gradually expand docs/docs_coverage_test.py to cover all packages (instead of a few whitelisted ones). The aqt package is one of the packages that is not tested for doc coverage yet.

@pschindler
Copy link
Collaborator

I improved the aqt device documentation. See PR #2578

CirqBot pushed a commit that referenced this issue Nov 21, 2019
…lator to AQTSamplerLocalSimulator (#2578)

The API for the AQT devices has been changed and should now be stable. The code for accessing the API has been changed and handling of connection errors has been improved.

This PR adds Z operations for the AQT device.

This PR addresses the issues #2194 #2091 

The documentation has been imroved, possible addressing #2503
@drewrisinger
Copy link
Contributor Author

Closing for inactivity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants