📝 Add documentation for ZX-calculus package. #817
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #817 +/- ##
=======================================
+ Coverage 92.2% 92.4% +0.1%
=======================================
Files 126 126
Lines 13832 13257 -575
Branches 2153 2033 -120
=======================================
- Hits 12762 12252 -510
+ Misses 1070 1005 -65
|
burgholzer
added
documentation
burgholzer
changed the title
burgholzer
reviewed
Jan 27, 2025
There was a problem hiding this comment.
These look phenomenal ✨ many thanks for taking the time to add these docstrings!
I just browsed through them and added a couple of inline comments where I noticed that something might be slightly off. Hope these help.
Looking forward to seeing this in the online documentation!
Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: Tom Peham <[email protected]>
Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: Tom Peham <[email protected]>
Co-authored-by: Lukas Burgholzer <[email protected]> Signed-off-by: Tom Peham <[email protected]>
We use Doxygen and Breathe to include the C++ API.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces documentation for the C++ ZX-calculus library.
Fixes #813
This change addresses concerns about missing documentation that came up in the revision openjournals/joss-reviews#7478 .
Checklist: