Rename show_idle and show_barrier to idle_wires and plot_barriers
#11878
Conversation
1ucian0
added
the
Changelog: API Change
1ucian0
requested review from
nonhermitian,
a team,
eggerdj and
wshanks
as code owners
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 8109859461Details
💛 - Coveralls |
| idle_wires: Optional[bool] = None, | ||
| plot_barriers: Optional[bool] = None, |
There was a problem hiding this comment.
Per the deprecation policy we need to add plot_barriers and idle_wires before we start emitting a deprecation warning here. This way users have a release of overlap where they can use the old and new without a deprecation warning being emitted. If deprecate_arg has a pending arg setting that would be enough, otherwise we'll have to remove the decorators and just add the new arguments.
There was a problem hiding this comment.
I added the pending=True in f4f6a64
mtreinish
added
Changelog: New Feature
| --- | ||
| deprecations: | ||
| - | | ||
| The parameters ``show_idle`` and ``show_barrier`` in the timeline drawers had been replaced by ``idle_wires`` and ``plot_barriers`` |
There was a problem hiding this comment.
Should we reword the reno to say that the new parameter names have been introduced and the old names will be deprecated in a following release?
There was a problem hiding this comment.
In my opinion, we should either remove all mentions of deprecation timings in the release note and trust the user to know/read about our deprecation policy OR we should be accurate about when we deprecate and remove things...
That said, I think it is rather minor issue here and I will approve the changes. :-)
| --- | ||
| deprecations: | ||
| - | | ||
| The parameters ``show_idle`` and ``show_barrier`` in the timeline drawers had been replaced by ``idle_wires`` and ``plot_barriers`` |
There was a problem hiding this comment.
In my opinion, we should either remove all mentions of deprecation timings in the release note and trust the user to know/read about our deprecation policy OR we should be accurate about when we deprecate and remove things...
That said, I think it is rather minor issue here and I will approve the changes. :-)
Fixes #11858
The parameters
show_idleandshow_barrierin the timeline drawers had been replaced byidle_wiresandplot_barriersrespectively to match the circuit drawer parameters. Their previous names are now deprecated and will be removed in the next major release. The new parameters are fully equivalent.