-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Rework QPY docs #10310
base: main
Are you sure you want to change the base?
Rework QPY docs #10310
Conversation
Pull Request Test Coverage Report for Build 5336201879
💛 - Coveralls |
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.
I've only done a quick high level skim over this so far. At a high level this reorganization is a huge improvement over the structure we had in the format docs before. Thanks for doing this!
What was missing before was the top overview of the current format. The historical artifacts are important for anyone potentially writing a deserializer for backwards compatibility. But for people trying to figure out how the format works and what terra is emitting today we had the order of everything backwards.
The one thing I also wanted to call out is that this will have a conflict with #10148 which is adding version 8. I wrote the docs there in the existing format. But we can handle the conflict based on what merges first I guess.
qiskit/qpy/__init__.py
Outdated
- When ``type==c``, :class:`~.QuantumCircuit` payloads follow | ||
- When ``type==s``, :class:`~.ScheduleBlock` payloads follow |
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.
Maybe link to the section too here. For circuit it's easy because it's right below. But for schedule block it's a lot of scrolling :)
One or more of the the following people are requested to review this:
|
Summary
Attempts to fix/improve #9967.
Details and comments
The QPY doc used to incrementally "build up" with every QPY release in a way that made it hard to get an overview of what the format looks like now. In this PR, I try to improve the readability fixing this issue and adding a few more changes, namely:
HEADER | DATA | ...
)Note: The local build/CI does not show document headings after a certain level ( the ones with
-------
or====
are not shown) in the sidebar menu, but the current deployed docs do show them, at least until (----
). I am assuming there is some difference in the Sphinx theme that doesn't show them.