Skip to content

Conversation

raynelfss
Copy link
Contributor

@raynelfss raynelfss commented Sep 5, 2025

Summary

The following PR moves any new release notes to the 2.2 folder, fixes the format and writing of the docstrings, and changes versioning to 2.2.0 for the final release.

Tasks (unordered)

  • Copy-editing from @beckykd
  • Consolidate all Standalone C-API passes release notes to one release note.
  • Write Prelude.
  • Test with wheels.

@raynelfss raynelfss added the Changelog: None Do not include in changelog label Sep 5, 2025
@raynelfss raynelfss added this to the 2.2.0 milestone Sep 5, 2025
@raynelfss raynelfss added the on hold Can not fix yet label Sep 5, 2025
Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

============

The :c:func:`qk_transpile` function exposes Qiskit's tranpsiler (:py:mod:`qiskit.transpiler`) to C.
The :cpp:func:`qk_transpile` function lets C access the Qiskit tranpsiler (:py:mod:`qiskit.transpiler`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why cpp over c? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly because the docs are not set up right, and this is the only way it links to it.

features_c:
- |
The ``QkTarget`` type is now able to represent targets that support
The ``QkTarget`` type can now represent targets that support
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Sphinx annotations are a bit inconsistent right now, e.g. why do we add c(pp):func to functions but not c:struct to the structs (same for enums)? Was there any update on the docs team if adding the annotation could enable links?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only reason why I don't add it here is because it doesn't link to the struct's page, either with :c:struct: or :cpp:struct:.

@eliarbel
Copy link
Member

The OpenQASM Features entry in the release notes refers to the DefcalInstruction class which was not added to the public API.
I believe it should be added @ElePT

@raynelfss raynelfss marked this pull request as ready for review September 16, 2025 19:38
@raynelfss raynelfss requested a review from a team as a code owner September 16, 2025 19:38
@qiskit-bot
Copy link
Collaborator

One or more of the following people are relevant to this code:

@eliarbel
Copy link
Member

Since this is now marked as Ready for Review, just a reminder that we still need to update the version numbers and remove release notes that were already covered in the 2.1 patches

raynelfss and others added 10 commits September 18, 2025 09:45
- Fix incorrect argument in `qk_transpile` function.
- Fixed more missed links from the c-api, temporarily linked with `:cpp:func:`.
- Other small tweaks.
- Remove all of the standalone C API pass release notes.
Co-authored-by: Julien Gacon <[email protected]>
Co-authored-by: Eli Arbel <[email protected]>
@raynelfss raynelfss added priority: high ci: test wheels Run the wheel-build scripts as an additional CI run for this PR and removed on hold Can not fix yet labels Sep 18, 2025
Comment on lines +26 to +27
For more information about the above and other changes made, please see the release notes below
and review the updated documentation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this sentence?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I included it since we mentioned it in the last 2.1 prelude

@raynelfss raynelfss requested a review from mtreinish September 18, 2025 16:42
mtreinish
mtreinish previously approved these changes Sep 18, 2025
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this LGTM now, I pushed up a small commit to fix some small things. I could probably continue to nitpick for a while so we should just move forward with this. If we spot anything else major in the release notes we can always circle back and fix it as part of the 2.2.1 bugfix release.

@raynelfss raynelfss dismissed mtreinish’s stale review September 18, 2025 20:07

Matthew found formatting issue

@mtreinish mtreinish merged commit c3e4977 into Qiskit:stable/2.2 Sep 18, 2025
45 of 51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog ci: test wheels Run the wheel-build scripts as an additional CI run for this PR priority: high
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants