docs: Add tket2-py module docstring #539
Merged
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 #539 +/- ##
===========================================
+ Coverage 84.00% 95.34% +11.34%
===========================================
Files 61 16 -45
Lines 6700 494 -6206
Branches 6206 0 -6206
===========================================
- Hits 5628 471 -5157
+ Misses 791 23 -768
+ Partials 281 0 -281
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ss2165
approved these changes
Aug 14, 2024
aborgna-q
force-pushed
the
ab/py-module-doc
branch
from
84892db to
34cbc45
Compare
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 14, 2024
🤖 I have created a release *beep* *boop* --- ## [0.2.1](tket2-py-v0.2.0...tket2-py-v0.2.1) (2024-08-14) ### Documentation * Add tket2-py module docstring ([#539](#539)) ([8ef7a57](8ef7a57)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Agustín Borgna <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Oct 3, 2024
🤖 I have created a release *beep* *boop* --- ## [0.4.0](tket2-py-v0.3.0...tket2-py-v0.4.0) (2024-10-01) ### ⚠ BREAKING CHANGES * Made all errors `non_exhaustive`, and renamed some fields for clarity. * "tket2.angle" extension replaced with "tket2.rotation" extension with rotation type and simplified set of operations. * TryFrom implementations for extension op structs removed, use `cast` ### Features * `BadgerOptimiser.load_precompiled`, `BadgerOptimiser.compile_eccs` and `passes.badger_pass` now take an optional `cost_fn` parameter to specify the cost function to minimise. Supported values are `'cx'` (default behaviour) and `'rz'`. ([83ebfcb](83ebfcb)) * simplify angle extension in to a half turns rotation type ([#611](#611)) ([0723937](0723937)) * Support encoding float and sympy ops ([#618](#618)) ([74dcbf7](74dcbf7)) * **tket2-hseries:** cli extension dumping ([#584](#584)) ([abf292f](abf292f)) ### Bug Fixes * remove TryFrom for extension ops use `cast` ([#592](#592)) ([5ca29af](5ca29af)) * Support hugr packages, fix the notebooks ([#622](#622)) ([1cf9dcb](1cf9dcb)) ### Documentation * Add tket2-py module docstring ([#539](#539)) ([8ef7a57](8ef7a57)) ### Miscellaneous Chores * Replace thiserror with derive_more 1.0 ([#624](#624)) ([2250ce7](2250ce7)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: Agustín Borgna <[email protected]> Co-authored-by: Agustín Borgna <[email protected]>
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.
Just copied the info from the README.
This is mainly intended to trigger a release-please PR for the component.