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. Matrix. Add descriptions to constants. #10

Open
stewdio opened this issue Jun 26, 2019 · 1 comment
Open

Docs. Matrix. Add descriptions to constants. #10

stewdio opened this issue Jun 26, 2019 · 1 comment

Comments

@stewdio
Copy link
Owner

stewdio commented Jun 26, 2019

Currently the Matrix documentation shows the code definition of each constant as well as the mathematical representation. But it does not explain what that constant is useful for. For example, what is the HADAMARD useful for? Write descriptions for all.

@stewdio
Copy link
Owner Author

stewdio commented Apr 16, 2020

Update: This now really applies too Gate documentation rather than Matrix. See https://quantumjavascript.app/Gate.html#Operations_with_2_%C3%97_2_matrices for the list.

All of these definitions need updates in general to reflect additions to how Gates are now defined—and how controlled gates are no longer defined by Gate but implicitly by the Circuit rendering routine. The short win is writing good brief descriptions of what the existing gates do conceptually—rather than just their mathematical definitions. The longer win is also solving how we want to be able to group several operations in to a compound operation and implementing that in code as well as describing that in the docs.

Altanali added a commit that referenced this issue Aug 16, 2021
remove extraneous console.log
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant