Explain QPY support in install#release-schedule #1563
Conversation
|
One or more of the following people are relevant to this code:
|
docs/start/install.mdx
Outdated
| <details> | ||
| <summary id="qpy-support"> | ||
| QPY support | ||
| </summary> |
There was a problem hiding this comment.
I would move this up to be adjacent to the upgrade strategy section before the pre and post-release sections. Realistically my old repeated complaint is that we need more hierarchy to the headings in this section of the docs is really showing here, because this will look pretty awkward on the rendered docs.
There was a problem hiding this comment.
@javabster @Eric-Arellano what do you think?
There was a problem hiding this comment.
moving it next to upgrade strategy makes sense to me. Also we will soon begin working on this issue to move some of the more open-source focused information into a dedicated section, instead of trying to squeeze it all into the install page, so hopefully this should help ease the header hierarchy issues
There was a problem hiding this comment.
This means we should merge this as suggested in this PR and move it with #605 ?
There was a problem hiding this comment.
it means we can move it next to the upgrade strategy for this PR. I just mentioned #605 in response to matthews comment about not liking the header hierarchy in general
There was a problem hiding this comment.
done and squashed. Thanks!
docs/start/install.mdx
Outdated
| to load QPY files generated with a newer version of Qiskit using an older release. To facilitate user migration across major version releases, the `qiskit.qpy.dump()` function will always support at least one overlapping version between the `X.0.0` and the `X-1.Y.0` release (where `Y` is the last minor version of | ||
| that series). This will enable saving QPY format files that can be loaded by both major versions from the newer | ||
| release. See more details in [RFC 0020](https://github.com/Qiskit/RFCs/blob/master/0020-release_cycle.md#qpy-support). |
There was a problem hiding this comment.
The only thing missing here is I think a link to the qpy dump() docs and also maybe calling out the version kwarg because that's the mechanism to support doing this. I might prefer linking to the qpy docs instead of the rfc.
Qiskit contract with respect of QPY is kind of strong and deserves an explanation. Adding it to https://docs.quantum.ibm.com/start/install#release-schedule
Qiskit contract with respect of QPY is kind of strong and deserves an explanation. Adding it to https://docs.quantum.ibm.com/start/install#release-schedule