Skip to content

Commit

Permalink
adding link in deprecation text
Browse files Browse the repository at this point in the history
  • Loading branch information
DanPuzzuoli committed Mar 15, 2024
1 parent b4166af commit c81ca79
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 19 deletions.
9 changes: 5 additions & 4 deletions qiskit_dynamics/array/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,11 @@
The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
0.5.0. The use of the ``Array`` class is no longer required to work with different array
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on
using different array libraries with Qiskit Dynamics. Users can now work directly with the
supported array type of their choice, without the need to wrap them to enable dispatching. The
``array`` and ``dispatch`` submodules will be removed in version 0.6.0.
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry
on using different array libraries with Qiskit Dynamics <how-to use different array libraries>`.
Users can now work directly with the supported array type of their choice, without the need to
wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in
version 0.6.0.
This module contains an :class:`Array` class that wraps N-dimensional array objects from different
libraries. It enables working with different array libraries through a common NumPy-based interface,
Expand Down
9 changes: 0 additions & 9 deletions qiskit_dynamics/arraylias/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,6 @@
.. currentmodule:: qiskit_dynamics.arraylias
.. warning::
The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
0.5.0. The use of the ``Array`` class is no longer required to work with different array
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on
using different array libraries with Qiskit Dynamics. Users can now work directly with the
supported array type of their choice, without the need to wrap them to enable dispatching. The
``array`` and ``dispatch`` submodules will be removed in version 0.6.0.
This module contains Qiskit Dynamics-global extensions of the default NumPy and SciPy aliases
provided by `Arraylias <https://qiskit-extensions.github.io/arraylias/>`_. These are used to manage
dispatching of array operations for the different array types supported by Qiskit Dynamics. They
Expand Down
14 changes: 12 additions & 2 deletions qiskit_dynamics/dispatch/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,18 @@
.. currentmodule:: qiskit_dynamics.dispatch
This module contains dispatch methods used by the
:class:`~qiskit_dynamics.array.Array` class.
.. warning::
The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
0.5.0. The use of the ``Array`` class is no longer required to work with different array
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry
on using different array libraries with Qiskit Dynamics <how-to use different array libraries>`.
Users can now work directly with the supported array type of their choice, without the need to
wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in
version 0.6.0.
This module contains dispatch methods used by the :class:`~qiskit_dynamics.array.Array` class.
Dispatch Functions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ upgrade:
- |
The ``array`` and ``dispatch`` submodules of Qiskit Dynamics have been deprecated as of version
0.5.0. The use of the ``Array`` class is no longer required to work with different array
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the user guide entry on
using different array libraries with Qiskit Dynamics. Users can now work directly with the
supported array type of their choice, without the need to wrap them to enable dispatching. The
``array`` and ``dispatch`` submodules will be removed in version 0.6.0.
libraries in Qiskit Dynamics, and is broken in some cases. Refer to the :ref:`user guide entry
on using different array libraries with Qiskit Dynamics <how-to use different array libraries>`.
Users can now work directly with the supported array type of their choice, without the need to
wrap them to enable dispatching. The ``array`` and ``dispatch`` submodules will be removed in
version 0.6.0.

0 comments on commit c81ca79

Please sign in to comment.