Add attribute documentation

Qiskit · Jan 30, 2024 · 2d38739 · 2d38739
1 parent 91d7a4b
commit 2d38739
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/qiskit/qpy/__init__.py b/qiskit/qpy/__init__.py
@@ -79,6 +79,19 @@
 
 .. autoexception:: QpyError
 
+Attributes:
+    QPY_VERSION (int): The current QPY format version as of this release. This
+        is the default value of the ``version`` keyword argument on
+        :func:`.qpy.dump` and also the upper bound for accepted values for
+        the same argument. This is also the upper bond on the versions supported
+        by :func:`.qpy.load`.
+
+    QPY_COMPATIBILITY_VERSION (int): The current minimum compatibility QPY
+        format version. This is the minimum version that :func:`.qpy.dump`
+        will accept for the ``version`` keyword argument. :func:`.qpy.load`
+        will be able to load all released format versions of QPY (up until
+        ``QPY_VERSION``).
+
 QPY Compatibility
 =================