-
Notifications
You must be signed in to change notification settings - Fork 18
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
Redesign documentation #25
Conversation
Codecov Report
@@ Coverage Diff @@
## master #25 +/- ##
==========================================
+ Coverage 98.70% 99.33% +0.62%
==========================================
Files 6 6
Lines 155 151 -4
==========================================
- Hits 153 150 -3
+ Misses 2 1 -1
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks awesome, thank you so much @mariaschuld! 😊 The changes related to old QubitDevice
methods and the new analytic_probability
method would be important, along with removing the attributes that render empty within the docs table (if agreed upon).
Left some suggestions apart from those. At times these refer to multiple places, left a marker at one or two places (these are mostly systematic things).
Also, would it be easy to add a bit of space to the bottom of the page where the Class diagrams are shown? (It's okay if not 😊 )
The JavaScript formattings seem to be off for CodeFactor 🤔 |
Have updated the codefactor settings to ignore javascript files! |
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
I think I caught most of your suggestions, and updated to reflect the latest qiskit polish as well. @josh146 I wonder why CodeFactor still complains about js files? |
Turn the cirq documentation into Xanadu style. It is recommended to locally build the documentation for code review.
We do currently not have a lot of content, but this can be the basis of growing the plugin.