Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Simulation magic command pages do not specify parameter formatting #725

Open
adrianleh opened this issue Aug 15, 2022 · 1 comment
Open
Labels
Area-Documentation Improvements or additions to documentation Kind-Enhancement New feature or request

Comments

@adrianleh
Copy link

On the documentation pages related to the %simulate, %simulate_sparse, %simulate_noise, %debug, and %trace, the expected format of parameters is not documented. For example, it is unclear how an array parameter should be specified.
It would be helpful to add a link to allowed parameters and their expected format/how they are parsed, along with further examples for common composite types such as arrays or tuples.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@msoeken msoeken transferred this issue from microsoft/QuantumLibraries Sep 18, 2022
@msoeken
Copy link
Member

msoeken commented Sep 18, 2022

Thanks for creating this issue @adrianleh. I am transferring the issue to the iqsharp repository, in which the magic commands are implemented.

@cgranade cgranade added Area-Documentation Improvements or additions to documentation Kind-Enhancement New feature or request labels Sep 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Area-Documentation Improvements or additions to documentation Kind-Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants