Skip to content

Commit

Permalink
add release note
Browse files Browse the repository at this point in the history
  • Loading branch information
@ibrahim-shehzad
ibrahim-shehzad committed Apr 3, 2024
1 parent 659b8b4 commit b66926a
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions releasenotes/notes/deprecate-cutqc-7541c514bd96fb05.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
deprecations:
- |
The ``circuit_cutting.cutqc`` package is deprecated and will be removed no sooner than Circuit Knitting Toolbox 0.8.0.
The wire cutting functionality in the ``circuit_knitting.cutting`` package will be maintained going forward.
Additionally, there is new automated LO gate and wire cut-finding functionality in the ``circuit_knitting.cutting.automated_cut_finding`` module.
See the ``docs/tutorials/04_automatic_cut_finding`` notebook for a tutorial on automated LO cut-finding.

This comment has been minimized.

Sign in to view

Copy link
@ibrahim-shehzad

ibrahim-shehzad Apr 3, 2024

Author Collaborator

Not a 100% on my choice of wording here, @caleb-johnson @garrison .

This comment has been minimized.

Sign in to view

Copy link
@caleb-johnson

caleb-johnson Apr 3, 2024

Collaborator

Look at the other release notes in the releasenotes/ dir and see how we use :func: and :mod: and :class: to link to specific places in the code.

circuit_cutting.cutqc is correct because it will be gone soon, so there will be nothing to link to. I'd recommend changing circuit_knitting.cutting.automated_cut_finding to :mod:circuit_knitting.cutting.automated_cut_finding and circuit_knitting.cutting to :mod:circuit_knitting.cutting

This comment has been minimized.

Sign in to view

Copy link
@caleb-johnson

caleb-johnson Apr 3, 2024 •
edited
Loading

Collaborator

When you make those changes, you can view the release notes in the rendered docs locally or here to make sure they link correctly.

If you go to the link, look for the html_docs button at the button that will download a zipped up rendering of the docs.

This comment has been minimized.

Sign in to view

Copy link
@ibrahim-shehzad

ibrahim-shehzad Apr 3, 2024

Author Collaborator

Right, yeah, I did check the build locally but my bad for not checking the links.

0 comments on commit b66926a

Please sign in to comment.