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

[Api Reference] Mistake in ControlledOnInt and ApplyControlledOnInt descriptions #612

Closed
remilvus opened this issue Aug 11, 2022 · 3 comments · Fixed by #615
Closed

[Api Reference] Mistake in ControlledOnInt and ApplyControlledOnInt descriptions #612

remilvus opened this issue Aug 11, 2022 · 3 comments · Fixed by #615
Assignees
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working Pkg-Standard Issue relates to the Microsoft.Quantum.Standard package.

Comments

@remilvus
Copy link
Contributor

In the API Reference, it's specified that ControlledOnInt and ApplyControlledOnInt functions should be used with a positive integer, but zero can also be used with these functions.
I suggest updating their descriptions from:
"(...) if the control register state corresponds to a specified positive integer." to
"(...) if the control register state corresponds to a specified non-negative integer."


Document details

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

@msoeken msoeken self-assigned this Aug 12, 2022
@msoeken msoeken added Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Pkg-Standard Issue relates to the Microsoft.Quantum.Standard package. labels Aug 12, 2022
@msoeken
Copy link
Member

msoeken commented Aug 19, 2022

Thanks for filing this issue @remilvus. Would you be interested in addressing this issue by creating a PR. I am happy to help.

@remilvus
Copy link
Contributor Author

I can create the PR. Thanks for offering your help, I will ask if any problems arise.

@remilvus
Copy link
Contributor Author

I've managed to do the fix 😃

@msoeken msoeken added the Kind-Bug Something isn't working label Sep 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working Pkg-Standard Issue relates to the Microsoft.Quantum.Standard package.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants