Qiskit / qiskit / 29070007303

88%

main: 88%

Build Type

push

github

Committed by web-flow

Commit Message

Fix deprecation documentation and warning text in qs_decomposition (#16542) (#16554)

The 2.5.0 deprecations in qs_decomposition rendered badly in the built
docs and produced garbled runtime warnings:

* The predicate-based deprecate_arg decorators for decomposer_1q and
  decomposer_2q misused removal_timeline, generating the sentence
  "It will be removed Accepting any other callable will no longer be
  supported from 3.0.0 on.". Since only certain values of these
  arguments are deprecated rather than the arguments themselves, the
  deprecation is now expressed with a manual warnings.warn call and a
  hand-written ".. deprecated::" directive in the docstring, as
  suggested in the issue.

* The docstring body still documented opt_a1 and opt_a2 as flags the
  caller should set. It now describes both optimizations as applied
  automatically, and the Args entries mark the arguments as deprecated.

* The deprecate_arg decorators for opt_a1 and opt_a2 (kept, since there
  the whole argument is deprecated) now set an explicit
  deprecation_description so the message reads naturally instead of
  leading with the fully qualified function path.

Runtime deprecation warnings still fire in the same situations as
before; only the wording changed.

Fixes #16515

(cherry picked from commit 9ec74158f)

Co-authored-by: Aly Abouzaid <35216698+alyabouzaid@users.noreply.github.com>

Coverage Stats

3 of 4 new or added lines in 1 file covered. (75.0%)

12 existing lines in 3 files now uncovered.

112784 of 128695 relevant lines covered (87.64%)

997516.76 hits per line