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

Provide more descriptive documentation on operations #134

Closed
Haishi2016 opened this issue Jun 26, 2019 · 2 comments
Closed

Provide more descriptive documentation on operations #134

Haishi2016 opened this issue Jun 26, 2019 · 2 comments
Labels
Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working

Comments

@Haishi2016
Copy link
Member

There's basically no descriptions on what each operation does. Sure, based on the operation name some experienced developer can infer/guess what it does, but it's pretty hard for a beginner to make sense of it. As an example, look at the documentation on "S" operation.

@cgranade cgranade transferred this issue from microsoft/Quantum Jul 11, 2019
@cgranade cgranade added Area-Documentation Issue relates to API documentation comments, READMEs, or other documentation in this repo. Kind-Bug Something isn't working labels Jul 11, 2019
@cgranade
Copy link
Contributor

For the example of the S operation, the API reference provides the matrix description of the operation:

image

This matrix form is a complete description of what the S operation does, but I definitely take the point that that is a bit hard for a beginner to make sense of. At the moment, the explanation of matrix notation for what the different operations each do is largely in the conceptual documentation about linear algebra, but that doesn't have much in the way of Q# examples to make it easier to understand how the reference documentation works.

Perhaps what might make the most sense is to open new issues to track the improvement of the conceptual articles and the list of other resources for beginners. I'll go on and do that, thanks for filing the issue!

@bromeg
Copy link

bromeg commented Aug 29, 2019

These types of operations are similar to calls to cos, sin, etc. We do not think reference documentation is the right place to explain what 'S' does, just like we wouldn't use reference docs to explain what cos is. However, we do think it will be valuable to add additional examples/tutorials to make these operations more approachable. We captured that in issue #113.

@bromeg bromeg closed this as completed Aug 29, 2019
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
Projects
None yet
Development

No branches or pull requests

3 participants