Add `add_deprecation_to_docstring` for docsite deprecation support #9685

Eric-Arellano · 2023-02-28T22:40:46Z

Summary

Rework of #8600 and supersedes #9611 and #1680.

We want to add .. deprecated:: directives to our documentation, but it would be repetitive to ask developers to copy both our runtime warnings (like via @deprecate_function) into the docstring too. And formatting for the directive can be tricky.

This adds the deprecated directive in-between the docstring summary and metadata like the arguments list. For example (this doesn't have the Sphinx Theme used):

Details and comments

Why edit docstring rather than use the Sphinx extension (#9611):

Editing the docstring also updates help(Foo), which is very useful for interactive development.
It simplifies how we deploy this functionality. See discussion on Remove Pauli v, w, and pauli_group() case arg as int #1680.
Unlike what I thought, we're not very concerned about performance. This algorithm is fast and it only impacts import time.

Why land this rather than #8600? It makes a big simplification: for deprecation of arguments, we insert the deprecation above the parameter list, like any normal deprecation. As explained at #1680, that is necessary to avoid needing to strip the docstring from deprecated arguments, which is bad. It also dramatically simplifies the implementation, e.g. dealing with indentation and missing parameters in the docstring. See that PR for more discussion.

qiskit-bot · 2023-02-28T22:40:51Z

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the the following people are requested to review this:

@Qiskit/terra-core

qiskit/utils/deprecation.py

test/python/utils/test_deprecation.py

…precation-via-docstring

jakelishman · 2023-02-28T23:09:28Z

I don't feel wildly strongly about this, but it runs counter to how other projects handle "changed in" and "new in" directives for arguments For example, here's a random Numpy docs page where you can see the "new in" and "changed in" directives (which work the same way as .. deprecated) are in-line with each argument. Here's the Python documentation for unittest.TestCase showing the same behaviour. This is mostly applicable for the case of renamed arguments (I'm not aware of any times an argument has removed, not just renamed), but that's the most common for us too, I think.

coveralls · 2023-02-28T23:10:55Z

Pull Request Test Coverage Report for Build 4408327792

30 of 30 (100.0%) changed or added relevant lines in 1 file are covered.
1 unchanged line in 1 file lost coverage.
Overall coverage increased (+0.003%) to 85.367%

Files with Coverage Reduction	New Missed Lines	%
qiskit/transpiler/passes/synthesis/unitary_synthesis.py	1	94.64%

Totals
Change from base Build 4407338982:	0.003%
Covered Lines:	68032
Relevant Lines:	79694

💛 - Coveralls

Eric-Arellano · 2023-03-01T13:42:25Z

For example, here's a random Numpy docs page where you can see the "new in" and "changed in" directives (which work the same way as .. deprecated) are in-line with each argument.

Hm, thanks for linking to that! I had a hell of a time last week trying to get deprecated directives to render properly inline with arguments. The only way I could pull it off without weird issues like two separate arguments lists was by removing the original docstring for the argument, which is bad.

But, your example suggests it theoretically should be possible.

Still, I've exceeded my timebox for this project already, particularly because of the new scope from #9676 and updating all of Terra to use it. I 100% agree showing the deprecation next to the argument is better, but, Luciano and I were thinking it's not "better enough" to justify the time required to get it working, given other project priorities. At least for now.

I opened #9699 to track this. If we get feedback that the current design is suboptimal, then we can decide to invest the time making that followup improvement. Wdyt?

…precation-via-docstring

jakelishman · 2023-03-01T15:23:32Z

If it's too complex to do inline, I'm happy to do it just in the body text like this PR as well. I don't know how Numpy automate things (if at all), though I suspect they probably process the source code for release during a package build including potentially modifying docstrings, since most of their stuff is all going to be done in C, not Python. That's likely a level of complexity too far for us.

Eric-Arellano · 2023-03-01T15:30:23Z

Cool, sgtm. Thanks!

This PR is ready to go then, and blocks #9676, which blocks the follow up PRs to migrate our repo to use these new decorators.

HuangJunye

I really like this approach. The test suite is great. It covers many different cases. I left a few inline comments. There are a bunch of suggestions because I think there should be 3 leading spaces for the deprecation message to align with the deprecated directive. The changes are just to add an extra space in the tests cases. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded and https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated

qiskit/utils/deprecation.py

test/python/utils/test_deprecation.py

qiskit/utils/deprecation.py

qiskit/algorithms/factorizers/shor.py

…precation-via-docstring

…rellano/qiskit-terra into deprecation-via-docstring

…o generate tests

…precation-via-docstring

…nts yet This makes the PR a smaller diff, so easier to review and also less risk when we land that it breaks something. Now, this PR only adds new functionality, the public `add_deprecation_to_docstring` function

qiskit/utils/deprecation.py

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

qiskit/utils/deprecation.py

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

1ucian0 · 2023-03-10T22:36:45Z

qiskit/utils/deprecation.py

+
+
+def add_deprecation_to_docstring(
+    func: Callable, msg: str, *, since: Optional[str], pending: bool


what's the point of the *?

It requires you to use keyword arguments for everything after the star. The reasons for that:

Call sites are clearer, rather than seeing a True or False with no context. IDEs make this less painful by showing what argument names are, but there are many contexts you read code w/o that, like GitHub or Vim.

More flexibility for the future of the API because we no longer need to worry about the order of positional arguments. Deprecating positional arguments is a pain.

jakelishman

Thanks for these changes - the tests look tonnes easier to read now as well. Given we're promoting add_deprecation_to_docstring to be public API, should we add a small "feature" release note to tell other developers about it?

jakelishman · 2023-03-13T18:16:51Z

qiskit/utils/deprecation.py

+        raise ValueError(
+            "Deprecation messages cannot contain new lines (`\\n`), but the deprecation for "
+            f'{func.__qualname__} had them. Usually this happens when using `"""` multiline '
+            f"strings; instead, use string concatenation.\n\n"
+            "This is a simplification to facilitate deprecation messages being added to the "
+            "documentation. If you have a compelling reason to need "
+            "new lines, feel free to improve this function or open a request at "
+            "https://github.com/Qiskit/qiskit-terra/issues."
+        )


It feels a bit hypocritical to complain that the developer uses a newline in their warning message when we do the exact same thing in this error message ;).

edit: not saying we need to change this. The situations are different.

…precation-via-docstring

…rellano/qiskit-terra into deprecation-via-docstring

Eric-Arellano · 2023-03-13T18:32:14Z

releasenotes/notes/new-deprecation-utilities-066aff05e221d7b1.yaml

@@ -0,0 +1,8 @@
+---


I named the release note this because I think it makes sense to include #9676 in the same note. (That PR will be unblocked after this lands 🎉)

the release note name doesn't actually appear publicly anywhere (technically it appears as a comment in the rst output by reno), so we've got some pretty funky ones historically. It technically defines the sort order of the output though haha

jakelishman

looks good to me, thanks for the work!

jakelishman · 2023-03-13T18:42:48Z

releasenotes/notes/new-deprecation-utilities-066aff05e221d7b1.yaml

+    so that the deprecation shows up in docs and with ``help()``. The deprecation decorators
+    from ``qiskit.util.deprecation`` call ``add_deprecation_to_docstring()`` already for you;
+    but you can call it directly if you are using different mechanisms for deprecations.


I guess this sentence is only true after #9676. As long as we also merge that before 0.24, we should be ok, otherwise we'll need to remember to remove it.

Agreed. I'm planning to put up a PR immediately after this that applies this helper to deprecate_arguments() and deprecate_function(). I reverted that from this PR to make it easier to review

And I have a couple PRs queued to finish this deprecation thing so I can finish by helping @woodsp-ibm with the algorithms pending deprecation change. Trying my best to land it all well before 0.24 :)

jakelishman · 2023-03-13T18:43:46Z

releasenotes/notes/new-deprecation-utilities-066aff05e221d7b1.yaml

@@ -0,0 +1,8 @@
+---


the release note name doesn't actually appear publicly anywhere (technically it appears as a comment in the rst output by reno), so we've got some pretty funky ones historically. It technically defines the sort order of the output though haha

commit 43a9dce Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Tue Mar 28 15:27:07 2023 -0600 Apply new deprecation decorators to algorithms folder (Qiskit#9864) * Apply new deprecation decorators to algorithms folder * Fix docstring starting on first line * Fix test due to positional args not triggering warning * Improve test further commit 67eaa4b Author: a-matsuo <47442626+a-matsuo@users.noreply.github.com> Date: Wed Mar 29 04:50:41 2023 +0900 Rearrange the gradient result based on the order of the input parameters (Qiskit#9503) * finite diff and spsa estimator gradient * for param shift, lin_comb, and reverse gradients * reverse estimator gradient * implemented the new feature * fix lint * fix test * fix and add reno * fix * fix style commit 7e09125 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Tue Mar 28 08:33:08 2023 -0600 Add `@deprecate_func` and `@deprecate_arg` decorators (Qiskit#9676) * Add `@deprecate_func` and `@deprecate_arg` decorators * Update the release note * Apply suggestions from code review Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * lint * Use PyPI package_name rather than loose English --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> commit 90b2439 Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue Mar 28 07:44:45 2023 -0400 Bump indexmap from 1.9.2 to 1.9.3 (Qiskit#9858) Bumps [indexmap](https://github.com/bluss/indexmap) from 1.9.2 to 1.9.3. - [Release notes](https://github.com/bluss/indexmap/releases) - [Changelog](https://github.com/bluss/indexmap/blob/master/RELEASES.md) - [Commits](indexmap-rs/indexmap@1.9.2...1.9.3) --- updated-dependencies: - dependency-name: indexmap dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> commit be8eeff Author: Evgenii Zheltonozhskii <zheltonozhskiy@gmail.com> Date: Tue Mar 28 12:59:41 2023 +0300 Fix mypy errors (circuit) (Qiskit#8267) * Fix circuit mypy errors * Fix 2 * Remove ignores * Remove ignores for sure * Remove TODO * fix for docs * Add annotation * Fix control bug, remove unnecessary annotation * Add test and fix description * Fix test * Reformat * Fix test description * Update releasenotes/notes/fix-control-with-string-parameter-4eb8a308170e08db.yaml Co-authored-by: Julien Gacon <gaconju@gmail.com> * More minor fixes * Fix callable import * Fix Instruction import for sphinx * Replace list[Any] with list --------- Co-authored-by: Julien Gacon <gaconju@gmail.com> commit 3118683 Author: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Date: Tue Mar 28 11:51:20 2023 +0200 Fix examples (Qiskit#9860) commit a36416b Author: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Date: Tue Mar 28 10:27:43 2023 +0200 Remove factorizers and linear solvers from `algorithms` (Qiskit#9832) * Remove factorizers and linear solvers * Add reno * Remove shor from backend tests * Fix reno * Apply suggestions from code review Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> * Apply review reno --------- Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> commit aacbc66 Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon Mar 27 19:13:15 2023 +0000 Bump pyo3 from 0.18.1 to 0.18.2 (Qiskit#9854) Bumps [pyo3](https://github.com/pyo3/pyo3) from 0.18.1 to 0.18.2. - [Release notes](https://github.com/pyo3/pyo3/releases) - [Changelog](https://github.com/PyO3/pyo3/blob/main/CHANGELOG.md) - [Commits](PyO3/pyo3@v0.18.1...v0.18.2) --- updated-dependencies: - dependency-name: pyo3 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> commit abfb53e Author: Jake Lishman <jake.lishman@ibm.com> Date: Mon Mar 27 15:06:28 2023 +0100 Ensure up-to-date `pip`, `setuptools` and `wheel` in CI (Qiskit#9850) Up-to-date Python packages should not require this step, however there are several packages, especially those that are optional for Terra functionality, that do not yet contain `pyproject.toml` files when building them from source. In these cases, `pip` will begin erroring out from version 23.1 if `wheel` is not installed. This commit proactively ensures that the minimum build dependencies for legacy Python packages is prepared and up-to-date before attempting installations; this includes ensuring that these are updated _inside_ any created venvs as well as outside them. commit 03473bd Author: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> Date: Mon Mar 27 12:23:12 2023 +0200 pin symengine to `<0.10.0` (Qiskit#9857) * pin symengine * Avoid specific version commit a1a67a1 Author: Matthew Treinish <mtreinish@kortar.org> Date: Fri Mar 24 14:34:53 2023 -0400 Add support to CouplingMap for disjoint qubits (Qiskit#9710) * Add support to CouplingMap for disjoint qubits Previously the CouplingMap class only supported graphs which were fully connected. This prevented us from modeling potential hardware which didn't have a path between all qubits. This isn't an inherent limitation of the underlying graph data structure but was a limitation put on the CouplingMap class because several pieces of the transpiler assume a path always exists between 2 qubits (mainly in layout and routing). This commit removes this limitation and also adds a method to get a subgraph CouplingMap for all the components of the CouplingMap. This enables us to model these devices with a CouplingMap, which is the first step towards supporting these devices in the transpiler. One limitation with this PR is most fo the layout and routing algorithms do not support disjoint connectivity. The primary exception being TrivialLayout (although the output might be invalid) VF2Layout and VF2PostLayout which inherently support this already. This commit lays the groundwork to fix this limitation in a follow-up PR but for the time being it just raises an error in those passes if a disconnected CouplingMap is being used. The intent here is to follow up to this commit soon for adding support for SabreLayout, SabreSwap, DenseLayout, and StochasticSwap to leverage the method get_component_subgraphs added here to make them usable on such coupling maps. * Remove coupling map connected check from NoiseAdaptiveLayout Noise adaptive layout doesn't use a CouplingMap so we can't check for a disconnected coupling map in it. * Change DenseLayout guard to only prevent running when it won't work * Rename get_component_subgraphs to components and cache result This commit renames the get_component_subgraphs() method to components() which is much more consise name. At the same time this adds caching to the return just in case building the component subgraphs is expensive to compute we only need to ever do it once. * Drop caching of connected components * Fix check for dense layout to do a valid comparison * Ensure self loops in CouplingMap.distance() return 0 In a previous commit the distance() method was updated to handle disjoint graphs correctly. Prior to this PR it was expected to raise when a path didn't exist between 2 qubits by nature of the distance matrix construction failing if there was a disconnected coupling map. Since that isn't the case after this PR the error condition was changed to check explicitly that there is no path available and then error. However, there was an issue in this case and self loops would incorrectly error as well when instead they should return 0. This commit updates the error check to ignore self loops so they return correctly. * Fix lint * Update CouplingMap.components() docstring Co-authored-by: Kevin Krsulich <kevin@krsulich.net> * Expand test coverage * Remove unused option for strongly connected components * Expand docstring to explain return list order * Use infinity for disconnected nodes in distance matrix * Update releasenotes/notes/add-cmap-componets-7ed56cdf294150f1.yaml * Rename CouplingMap.components to connected_components() THis commit renames the CouplingMap.components() method to connected_components(). It also adds an example to the docstring to better explain what a connected component is. * Fix typo in relaese note * Update method name in release note * Restore previous reduce() behavior The current reduce() error behavior of raising on trying to reduce to a disconnected coupling map is being depended on in other locations. To avoid a potentially breaking change this commit reverts the removal of that limitation in the method. We can look at doing that in the future independently of this PR because removing this specific restriction on the reduce() method is not 100% tied to generally allowing disconnected coupling map objects. * Add missing import --------- Co-authored-by: Kevin Krsulich <kevin@krsulich.net> commit 0bd4cfd Author: Matthew Treinish <mtreinish@kortar.org> Date: Fri Mar 24 10:48:21 2023 -0400 Add option to skip deepcopy on dag_to_circuit (Qiskit#9825) * Add option to skip deepcopy on dag_to_circuit This commit adds a new option, copy_operations, which allows to disable the deepcopy on dag_to_circuit(). Previously the dag to circuit converter would always deep copy the operations, however in the transpiler we don't need this extra overhead because the DAGCircuits are temporary internal artifacts and will not be resused outside of the transpiler. So we can avoid the copy overhead in these situations, however in general the converter needs to default to copying. This new argument enables this workflow by keeping the current behavior by default but enabling the transpiler to skip copying operations in the output conversion. * Fix docs typo * Fix docs typo again * Use copy_operations=False in more locations commit dfcfa4a Author: Jake Lishman <jake.lishman@ibm.com> Date: Fri Mar 24 13:16:58 2023 +0000 Remove dependency on sphinx-autodoc-typehints (Qiskit#9705) * Remove dependency on sphinx-autodoc-typehints This replaces the whole usage of the separate package `sphinx-autodoc-typehints` with the built-in support from `autodoc`, available (with this combination of options) since Sphinx 5.0. This removes a docs dependency that has caused us significant problems before due to its instability, and the built-in handling in `autodoc` is much cleaner as well; rather than trying to textually modify the docstring, this version (correctly) mutates the parsed rST structure, which also naturally it 100% compatible with the Napoleon processing. * Maintain previous type-hint behaviour commit 4a63b17 Author: Jake Lishman <jake.lishman@ibm.com> Date: Fri Mar 24 13:14:07 2023 +0000 Move OQ3 exporter tests to qasm3 module (Qiskit#9844) * Move OQ3 exporter tests to qasm3 module These previously lived in `test/python/circuit` just for historical reasons (the OQ2 exporter lives there because it's a method on `QuantumCircuit`). Since we have a dedicated `qasm3` module now, including in the test suite, it makes sense to move the file there. * Add missing __init__.py commit 9c8eb06 Author: Julien Gacon <gaconju@gmail.com> Date: Fri Mar 24 08:46:38 2023 +0100 Improve ``Parameter`` handling in ``SparsePauliOp`` (Qiskit#9796) * add reno * Add assign_parameters and parameter in init * add SPO.parameters and remove utils * fix ParameterValueType typehint * Update qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py Co-authored-by: Ikko Hamamura <ikkoham@users.noreply.github.com> * remove trailing print * Elena's comments Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> * fix line length --------- Co-authored-by: Ikko Hamamura <ikkoham@users.noreply.github.com> Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com> commit 7bb4af9 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu Mar 23 09:24:43 2023 -0600 Remove tweedledum from requirements-dev.txt (Qiskit#9759) commit 5a19f8a Author: Jake Lishman <jake.lishman@ibm.com> Date: Thu Mar 23 13:57:23 2023 +0000 Fix missing handling of no-synthesis case in `UnitarySynthesis` (Qiskit#9843) Since moving `Optimize1qDecomposition` down to the Rust level, some of its use in the default `UnitarySynthesis` plugin was allowing `None` to be passed to an internal function unchecked. This correctly returns the "could not synthesise" value when appropriate. commit 84a0fdd Author: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> Date: Thu Mar 23 10:37:34 2023 +0900 Performance improvement of `SparsePauliOp.to_matrix` (Qiskit#9620) * optimize SparsePauliOp.to_matrix * optimize dense * proper vectorize * update copyright year * small opt * update a comment commit 262cf08 Author: Jake Lishman <jake.lishman@ibm.com> Date: Wed Mar 22 16:11:35 2023 +0000 Revert "Start deprecation of complex parameters in Qiskit Pulse (Qiskit#9735)" (Qiskit#9838) This reverts commit eb4c5cb. This is currently causing flaky CI on Windows, so is being temporarily reverted while a fix can be made. commit 789d588 Author: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> Date: Wed Mar 22 09:28:19 2023 -0400 Update codeowners (Qiskit#9835) commit eb4c5cb Author: TsafrirA <113579969+TsafrirA@users.noreply.github.com> Date: Tue Mar 21 03:10:59 2023 +0200 Start deprecation of complex parameters in Qiskit Pulse (Qiskit#9735) * Add warning and update tests * Release notes * Move warning to all Pulse objects. * Fix releasenote typo * Move warning to format_parameter_value commit 6cec912 Author: Matthew Treinish <mtreinish@kortar.org> Date: Mon Mar 20 13:26:41 2023 -0400 Fix non-complex dtypes in OneQubitEulerDecomposer methods (Qiskit#9828) * Fix non-complex dtypes in OneQubitEulerDecomposer methods This commit fixes a regression introduced in the rewrite of the internals of the OneQubitEulerDecomposer class to be in rust. Previously the angles() and angles_and_phase() methods of OneQubitEulerDecomposer would work with a non-complex dtype in the input, however because the rust component of the module is strictly typed to only work with a complex128 dtype passing the array to rust to compute the angles and phase of the unitary would fail. To address this limitation this commit casts the input matrix to be complex before passing it to the rust function. Fixes Qiskit#9827 * Cleanup release note * Update test/python/quantum_info/test_synthesis.py Co-authored-by: Jake Lishman <jake@binhbar.com> --------- Co-authored-by: Jake Lishman <jake@binhbar.com> commit 9500f42 Author: Etienne Wodey <44871469+airwoodix@users.noreply.github.com> Date: Mon Mar 20 15:30:55 2023 +0100 transpile: narrow the return type depending on the circuits argument (Qiskit#9799) * transpile: narrow the return type depending on the circuits argument * Fixup release note --------- Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit 8ceb57d Author: Takashi Imamichi <31178928+t-imamichi@users.noreply.github.com> Date: Mon Mar 20 22:38:07 2023 +0900 fix qasm with reset (Qiskit#9819) commit e2f6606 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri Mar 17 11:36:27 2023 -0600 Consolidate `pip install` calls in CI (Qiskit#9757) * Remove unnecessary `pip install` in CI * Consolidate `pip install` calls in CI * Add back `-U` * Go back to editable install so Rust is in debug mode * Add RUST_DEBUG env var so we can avoid editable install * Remove SETUPTOOLS_ENABLE_FEATURES and also Aer from lint job * See if editable install fixes Pylint * Give up on not using editable installs in CI I don't know why they're causing issues with loading the Rust extension. But it's not a priority to figure that out. This PR is still some forward progress. commit 2afcebc Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri Mar 17 11:34:25 2023 -0600 Fix Tox installing Terra from PyPI (Qiskit#9758) * Fix Tox installing Terra from PyPI * Don't use editable mode commit b00a8de Author: Matthew Treinish <mtreinish@kortar.org> Date: Thu Mar 16 18:32:14 2023 -0400 Stop using mergify merge queue feature (Qiskit#9807) Due to recent changes in the mergify configuration/service the merge queue feature of mergify is no longer working as expected. It's not clear if this just a temporary bug in mergify, a longer term change in behavior (which requires all PR authors to be registered on mergify), or some incompatibility between the github api and mergify. However, because we're no longer able to rely on it we've moved to using github's native merge queue feature [1][2] instead. Since this new merge queue would conflict with mergify's this commit removes the merge queue configuration from the mergify configuration. The configuration for stable backporting is left in place because github doesn't natively offer that feature and it appears to still work fine. [1] https://github.blog/changelog/2023-02-08-pull-request-merge-queue-public-beta/ [2] https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue commit 07ca200 Author: Julien Gacon <gaconju@gmail.com> Date: Thu Mar 16 20:20:04 2023 +0100 Clip probabilities in ``QuantumState`` (Qiskit#9762) * Clip probabilities * clip implictly * add reno * add tests * add renormalization * use sum, not norm * ensure round still works * normalizing seems to re-introduce errors * Tighten floating-point tests In cases of rounding and clipping, it's important that the floating-point output is bit-for-bit correct, so the fuzzy tests weren't ideal (some of these were strict, but it was inconsistent). It's better to use `assertEqual` rather than `assertTrue` where possible so we get better errors on failure. --------- Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit 5a9d041 Author: Jake Lishman <jake.lishman@ibm.com> Date: Thu Mar 16 18:50:07 2023 +0000 Remove useless `into_iter()` on `Range` (Qiskit#9806) Clippy has started complaining about this on the stable branch, and it's probably correct to do so. commit bbd023b Author: Matthew Treinish <mtreinish@kortar.org> Date: Thu Mar 16 14:44:44 2023 -0400 Leverage Rust circuit sequence construction for `OneQubitEulerDecomposer` (Qiskit#9583) * Leverage Rust circuit sequence construction for OneQubitEulerDecomposer This commit is a follow-up to Qiskit#9578 which added a rust implementation of the second half of the single qubit euler decomposition routines and leveraged them for the Optimize1qGatesDecomposition transpiler pass. With that PR the Optimize1qGatesDecomposition no longer was dependent on the OneQubitEulerDecomposer class. This commit continues from that PR and updates the OneQubitEulerDecomposer to leverage the same Rust implementation internally. Calling a decomposer object will internally call the rust function to generate a circuit sequence and then return either a QuantumCircuit or DAGCircuit (depending on the options). Similarly all the angle computation is done directly in Rust. * Add missing atol clamping to mod_2pi The python version of the OneQubitEulerDecomposer class had atol clamping on it's output from mod_2pi, when this function was ported to rust this was not included. At the time it was because nothing set the atol parameter when calling mod_2pi (the angle calculation in Qiskit#9185 did not have atol and the expansion to construct circuits for Optimize1qGatesDecomposition always used the default value). However, now that we're expanding OneQubitEulerDecomposer to internally do all the calculations in rust we need to support an adjustable atol which includes the missing endpoint clamping in mod_2pi. This commit adds this missing functionality to the function. * Add docstring to mod_2pi rust function * Remove mod_2pi python function commit 0d15506 Author: sg495 <sg495@users.noreply.github.com> Date: Thu Mar 16 18:40:33 2023 +0000 new parameters in `plot_bloch_multivector`: `figsize`, `font_size`, and `title_font_size` (Qiskit#7264) * Update state_visualization.py Closes Qiskit#7263 * Introduced font size, title font size and title padding to plot_bloch_multivector * Update state_visualization.py Documented new kwargs. * Fixed code formatting issues in previous commits of Qiskit#7264. * Update qiskit/visualization/bloch.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/visualization/bloch.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/visualization/state_visualization.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/visualization/state_visualization.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Create update-state-visualization-6836bd53e3a24891.yaml Added release notes. * Update test_graph_matplotlib_drawer.py Included a test for the new features. * fix test * blacking --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> commit a85456d Author: Jim Garrison <jim@garrison.cc> Date: Thu Mar 16 14:40:16 2023 -0400 Remove shared `black`/`lint/`lint-incr` `envdir` in `tox.ini` (Qiskit#9800) Under tox3, it was faster to have the `black`, `lint`, and `lint-incr` environments share an `envdir`. However, tox4 recreates the environment every time one switches from one to another when they share an `envdir`, leading to much slower execution. Here I've changed these environments to all use the default (unique) directory rather than a shared one. Closes Qiskit#9782 commit b047a7c Author: Matthew Treinish <mtreinish@kortar.org> Date: Thu Mar 16 17:29:12 2023 -0400 Attempt to trigger Azure pipelines on merge queue events (Qiskit#9809) * Attempt to trigger Azure pipelines on merge queue events This commit attempts to add a trigger condition to our azure pipelines job to trigger on commits to the gh merge queue branch. * Only trigger PR CI in queue, not push CI --------- Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit b4bc559 Author: Luciano Bello <bel@zurich.ibm.com> Date: Thu Mar 16 15:56:55 2023 +0100 Some doc formatting and link, mostly on quantumcircuit.py file (Qiskit#9771) * some doc formating and link, mostly on quantumcircuit.py file * Update qiskit/circuit/quantumcircuit.py Co-authored-by: Julien Gacon <gaconju@gmail.com> * ident * more typos * more typos * another iteration * Bit and Register * notes on Register and Bit * Update qiskit/circuit/bit.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * Update qiskit/circuit/register.py Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> --------- Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit c37cec2 Author: Jim Garrison <jim@garrison.cc> Date: Thu Mar 16 00:26:01 2023 -0400 Remove implicit broadcasting from `Pauli`/label construction of `PauliList` (Qiskit#9779) * Remove implicit broadcasting from `Pauli`/label construction of `PauliList` * Update releasenotes/notes/paulilist-do-not-broadcast-from-paulis-96de3832fba21b94.yaml Co-authored-by: Jake Lishman <jake@binhbar.com> --------- Co-authored-by: Jake Lishman <jake@binhbar.com> Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit b0b5541 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed Mar 15 14:09:13 2023 -0600 `@deprecate_arguments` and `@deprecate_function` add deprecation to docstring (Qiskit#9790) commit fa4a136 Author: Alexander Ivrii <alexi@il.ibm.com> Date: Wed Mar 15 00:21:35 2023 +0200 Alternative construction mechanism for HLS config (Qiskit#9413) * Alternative construction mechanism for HLS config * improved how synthesis methods can be specified * fixes * pass over release notes * adding tests for short form * Updating the documentation of HLSConfig and HighLevelSynthesis * removing unnecessary import in documentation --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> commit 6bb4957 Author: Luciano Bello <bel@zurich.ibm.com> Date: Tue Mar 14 21:41:02 2023 +0100 extend the documentation for qiskit.circuit.QuantumCircuit.measure (Qiskit#9698) * extend the documentation for qiskit.circuit.QuantumCircuit.measure * spelling * H * qregs and cregs * spelling * Update qiskit/circuit/quantumcircuit.py * Update qiskit/circuit/quantumcircuit.py * Update qiskit/circuit/quantumcircuit.py * Update qiskit/circuit/quantumcircuit.py * examples after Args/Return/Raises * Update qiskit/circuit/quantumcircuit.py Co-authored-by: Jake Lishman <jake@binhbar.com> * short description * better description * as equivalence * shorten it a bit * :: * raw string * lvert * Tweak grammar --------- Co-authored-by: Junye Huang <h.jun.ye@gmail.com> Co-authored-by: Jake Lishman <jake@binhbar.com> commit bf3bb96 Author: Matthew Treinish <mtreinish@kortar.org> Date: Tue Mar 14 10:18:45 2023 -0400 Fix basis_gates and coupling_map backend override in transpile() (Qiskit#9789) This commit fixes an issue in the transpile() function when a user specified the `backend` argument with a BackendV2 based backend along with `basis_gates` or `coupling_map`. In this case the `transpile()` was generating the preset pass manager with a target, coupling map, and basis gates list. However, most individual passes that take basis gates and a Target will prefer to use the target if both are specified. This is generally sane behavior at the pass level because the target contains more rich data and tighter constraints that a transpiler pass will need to worry about. To fix this limitation this commit updates transpile() to not use the backend's target if either basis_gates or coupling_map are specified. Longer term this should no longer be an issue when Qiskit#9256 is implemented and we'll be relying solely on a target internally. But this fix is needed until Qiskit#9256 is started. Fixes Qiskit#9781 Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 648da26 Author: Jake Lishman <jake.lishman@ibm.com> Date: Tue Mar 14 13:25:52 2023 +0000 Improve error messages in `Target`-based `GateDirection` pass (Qiskit#9787) * Improve error messages in `Target`-based `GateDirection` pass The `Target` version of `GateDirection` has more information available to make better error messages. It can distinguish cases where the failure is because a gate would be valid if flipped but the pass doesn't know how to do it, and the case where the gate wouldn't be valid in either direction. * Reword error message on failed flip --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 3005806 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Mon Mar 13 13:30:26 2023 -0600 Add `add_deprecation_to_docstring` for docsite deprecation support (Qiskit#9685) * Add deprecations to function docstring * Work around issue with multiline strings * Better variable name * Jake's review feedback * Make Napoleon check case-insensitive * Promote add_deprecation_to_docstring to be public It may be useful for Applications/Ecosystem, when they want this functionality but want to keep using their own deprecation decorators * Properly error when metadata line is the first line * Tests feedback: don't use helper function and simplify instructions to generate tests * Don't use the function with @deprecate_function and @deprecate_arguments yet This makes the PR a smaller diff, so easier to review and also less risk when we land that it breaks something. Now, this PR only adds new functionality, the public `add_deprecation_to_docstring` function * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Add release note --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com> commit c2affb1 Author: Jake Lishman <jake.lishman@ibm.com> Date: Mon Mar 13 16:38:36 2023 +0000 Fix explicitly calibrated gates in `GateDirection` (Qiskit#9786) If there is an explicit calibration given, this overrides the generic information from the `CouplingMap` or the `Target` for that particular instance, since one can use pulse-level control to define gates on a circuit-by-circuit basis that are not generically available in a way that can be specified in the coupling or target. commit 2ce129a Author: Naoki Kanazawa <nkanazawa1989@gmail.com> Date: Mon Mar 13 22:08:35 2023 +0900 Fix unitary synthesis module to get proper error value when it's empty. (Qiskit#9774) Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 6829bb1 Author: Kazuki Tsuoka <kazukitsuoka@g.ecc.u-tokyo.ac.jp> Date: Sun Mar 12 16:27:55 2023 +0900 Fix `Parameter.is_real()` (Qiskit#9664) * fix bug * add reno * Update releasenotes/notes/fix-parameter-is_real-8b8f99811e58075e.yaml --------- Co-authored-by: Julien Gacon <gaconju@gmail.com> commit 5a62949 Author: Luciano Bello <bel@zurich.ibm.com> Date: Fri Mar 10 23:40:07 2023 +0100 Qiskit gates not `qelib1.inc` are now defined when dumped (Qiskit#9777) * non-standard gates * Qiskit gates not qelib1.inc are now defined when dumped --------- Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 5ce80ab Author: Daniel Puzzuoli <dan.puzzuoli@gmail.com> Date: Fri Mar 10 11:49:56 2023 -0800 Implementing CouplingMap.__eq__ (Qiskit#9766) * implementing Coupling.__eq__ * Update qiskit/transpiler/coupling.py Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * adding comments to test, and adding release note * black formatting * updating CouplingMap.__eq__ to check edge list equality instead of isomorphism * updating release notes * updating test doc string * Update test/python/transpiler/test_coupling.py Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Update test/python/transpiler/test_coupling.py Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Update test/python/transpiler/test_coupling.py Co-authored-by: Matthew Treinish <mtreinish@kortar.org> * Update test/python/transpiler/test_coupling.py Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org> commit 332f4b2 Author: Jake Lishman <jake.lishman@ibm.com> Date: Fri Mar 10 08:31:36 2023 +0000 Fix zero-qubit `Pauli` label strings (Qiskit#9726) It was previously possible to construct a zero-qubit Pauli operator using the array form (`Pauli(([], []))`), or by empty-slicing an existing Pauli (`Pauli("IXZ")[[]]`). This commit completes the set by making labels with no qubits work as well, for consistency. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 3284ea0 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Thu Mar 9 17:56:54 2023 -0600 Fix `tox -e docs` for macOS (Qiskit#9765) * Fix `tox -e docs` for macOS Co-authored-by: Jake Lishman <jake@binhbar.com> * Fix two issues. Duh, thanks Jake * Update Azure job to set RUST_DEBUG Not strictly necessary since Tox already sets it. But makes things consistent and avoids accidentally removing this in the future --------- Co-authored-by: Jake Lishman <jake@binhbar.com> commit d272919 Author: Matthew Treinish <mtreinish@kortar.org> Date: Thu Mar 9 18:11:05 2023 -0500 Suppress PulseSimulator deprecation warning in tests (Qiskit#9767) In the recently released qiskit-aer 0.12.0 the PulseSimulator backend (used as its name implies to simulate pulse schedules) was deprecated in favor of the actively maintained qiskit-dynamcis package. This deprecation is causing test failures when running our test suite with qiskit-aer installed because a single test was opportunistically using the PulseSimulator backend when aer was installed. This commit adds an assertion to catch the DeprecationWarning and adds a comment to rewrite the test to use dynamics. Although we may not wish to add the optional bidirectional dependency for a single test, in which case we should just delete the test. But that is a discussion for a follow up PR when CI is not blocked by an upstream package's release. This commit is just a short term workaround to unblock forward progress. commit fa7ac68 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed Mar 8 12:05:55 2023 -0600 Don't require Tweedledum for `qiskit.circuit.classicalfunction` on import (Qiskit#9754) * Don't require Tweedledum for `qiskit.circuit.classicalfunction` on import * Review feedback commit 9d33618 Author: Jake Lishman <jake.lishman@ibm.com> Date: Wed Mar 8 15:47:39 2023 +0000 Fix docs build on case-insensitive systems (Qiskit#9748) During the switchover of the `SymbolicPulse` classes in the pulse library, there are several objects documented under `qiskit.library.pulse` that differ only by capitalisation. Under `autosummary`, these therefore generate files with names that differ only by capitalisation, which causes naming clashes on systems that have case-insensitive semantics, such as macOS. This then causes warnings to be emitted from the Sphinx build, failing it. Autosummary has this setting that can be used as a workaround. I went this route rather than converting the documentation to use more inline documentation for the library for now, because I expect the clash to be more short-lived, and I didn't want to make a change that meaningful impacts the style of the documentation without knowing the full context around it. Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> commit 16f6adb Author: Junye Huang <h.jun.ye@gmail.com> Date: Wed Mar 8 14:09:39 2023 +0100 Remove non-existent files from MANIFEST.in (Qiskit#9752) * remove qiskit/schemas * remove include cython files * remove include pickle files commit fe12c26 Author: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Tue Mar 7 18:44:38 2023 -0600 Tag Eric in Rust changes (Qiskit#9749) commit c6cd0d5 Author: Jake Lishman <jake.lishman@ibm.com> Date: Tue Mar 7 23:12:39 2023 +0000 Add structure for multiple Rust crates (Qiskit#9742) * Add structure for multiplie Rust extension crates This is a precursor to adding an entirely separate and self-contained crate to handle parsing of OpenQASM 2 (not 3 - this is kind of like a trial run for that). It could conceivably still live within `qiskit._accelerate`, but having separate crates helps us enforce more sane API barriers, and has improvements in the incremental build time when working on only one of the Rust extensions. The intent after this commit is still to have `qiskit._accelerate` as an easy catch-all for accelerators for Python. Developers should not need to be concerned with defining a new crate for every new feature, and for the most part `_accelerate` is still logically interoperative within itself (for example, `NLayout` is used all over). This is just laying out the groundwork so more complex crate additions _can_ also be made. Some of the niceties to do with Cargo workspaces only became stabilised in Rust 1.64. In particular, inheritance from the workspace root for things like the package version, Rust version, and dependencies only came in then. For now, the `workspace.packages` key in the root `Cargo.toml` is ignored with a small warning during the build, but I've put it in place mostly to keep track of what we can change once the MSRV becomes 1.64 or greater (likely not til at least Terra 0.26). * Add README.md to crates/accelerate * Correct licence metadata commit 2553376 Author: Julien Gacon <gaconju@gmail.com> Date: Tue Mar 7 13:15:22 2023 +0100 Fix bitstring padding in the `BackendSampler` (Qiskit#9744) * fix padding * add reno commit 5c49d14 Author: Etienne Wodey <44871469+airwoodix@users.noreply.github.com> Date: Mon Mar 6 20:25:02 2023 +0100 test/transpiler: add regression tests for Qiskit#9701 (Qiskit#9739) commit 80ca1f3 Author: Shelly Garion <46566946+ShellyGarion@users.noreply.github.com> Date: Mon Mar 6 19:23:14 2023 +0200 Add inverse method to ECRGate (Qiskit#9733) * add inverse method to ECRGate * add release notes * Fix sphinx tags * Recategorise as bugfix --------- Co-authored-by: Julien Gacon <gaconju@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Jake Lishman <jake.lishman@ibm.com> commit 126c9ba Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon Mar 6 14:12:24 2023 +0000 Bump rayon from 1.6.1 to 1.7.0 (Qiskit#9737) Bumps [rayon](https://github.com/rayon-rs/rayon) from 1.6.1 to 1.7.0. - [Release notes](https://github.com/rayon-rs/rayon/releases) - [Changelog](https://github.com/rayon-rs/rayon/blob/master/RELEASES.md) - [Commits](rayon-rs/rayon@rayon-core-v1.6.1...rayon-core-v1.7.0) --- updated-dependencies: - dependency-name: rayon dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit 6d12cdd Author: Junye Huang <h.jun.ye@gmail.com> Date: Mon Mar 6 13:57:14 2023 +0100 Update slack invite link to https://qisk.it/join-slack (Qiskit#9736) commit b99ef32 Author: Jake Lishman <jake.lishman@ibm.com> Date: Sun Mar 5 15:59:19 2023 +0000 Add docs team to tag list for docs configuation changes (Qiskit#9714) This adds the current docs team to the qiskit-bot configuration to get automatically tagged when changes to the `docs` folder are made. For the most part, this should just be about the documentation build itself, which is under their umbrella, rather than the text of the API docs which is largely generated from Terra's Python source code. Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> commit dbdf867 Author: John Lapeyre <jlapeyre@users.noreply.github.com> Date: Sat Mar 4 13:43:06 2023 -0500 Fix typo in docstring (Qiskit#9730)

…iskit#9685) * Add deprecations to function docstring * Work around issue with multiline strings * Better variable name * Jake's review feedback * Make Napoleon check case-insensitive * Promote add_deprecation_to_docstring to be public It may be useful for Applications/Ecosystem, when they want this functionality but want to keep using their own deprecation decorators * Properly error when metadata line is the first line * Tests feedback: don't use helper function and simplify instructions to generate tests * Don't use the function with @deprecate_function and @deprecate_arguments yet This makes the PR a smaller diff, so easier to review and also less risk when we land that it breaks something. Now, this PR only adds new functionality, the public `add_deprecation_to_docstring` function * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Add release note --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

…iskit/qiskit#9685) * Add deprecations to function docstring * Work around issue with multiline strings * Better variable name * Jake's review feedback * Make Napoleon check case-insensitive * Promote add_deprecation_to_docstring to be public It may be useful for Applications/Ecosystem, when they want this functionality but want to keep using their own deprecation decorators * Properly error when metadata line is the first line * Tests feedback: don't use helper function and simplify instructions to generate tests * Don't use the function with @deprecate_function and @deprecate_arguments yet This makes the PR a smaller diff, so easier to review and also less risk when we land that it breaks something. Now, this PR only adds new functionality, the public `add_deprecation_to_docstring` function * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Update qiskit/utils/deprecation.py Co-authored-by: Luciano Bello <bel@zurich.ibm.com> * Add release note --------- Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Add deprecations to function docstring

e8bd369

Eric-Arellano added the Changelog: None Do not include in changelog label Feb 28, 2023

Eric-Arellano requested review from 1ucian0, jakelishman, HuangJunye and levbishop February 28, 2023 22:40

Eric-Arellano requested review from a team, manoelmarques and woodsp-ibm as code owners February 28, 2023 22:40

This was referenced Feb 28, 2023

[WAIT TO MERGE] Add extension to add deprecated directives Qiskit/qiskit-metapackage#1680

Closed

[WAIT TO MERGE] Store deprecation metadata on functions for docs generation #9611

Closed

Eric-Arellano commented Feb 28, 2023

View reviewed changes

qiskit/utils/deprecation.py Outdated Show resolved Hide resolved

qiskit/utils/deprecation.py Outdated Show resolved Hide resolved

qiskit/utils/deprecation.py Outdated Show resolved Hide resolved

test/python/utils/test_deprecation.py Outdated Show resolved Hide resolved

Merge branch 'main' of https://github.com/Qiskit/qiskit-terra into de…

2679c84

…precation-via-docstring

Eric-Arellano added 2 commits March 1, 2023 09:14

Work around issue with multiline strings

f5a49e4

Merge branch 'main' of https://github.com/Qiskit/qiskit-terra into de…

5eab996

…precation-via-docstring

Eric-Arellano requested a review from ElePT as a code owner March 1, 2023 15:14

Eric-Arellano mentioned this pull request Mar 1, 2023

Consider improving deprecations of arguments to show up in docs next to the arg #9699

Open

Merge branch 'main' into deprecation-via-docstring

300903e

Eric-Arellano mentioned this pull request Mar 1, 2023

Add @deprecate_func and @deprecate_arg decorators #9676

Merged

HuangJunye self-assigned this Mar 2, 2023

HuangJunye reviewed Mar 3, 2023

View reviewed changes

Eric-Arellano added 3 commits March 3, 2023 09:17

Merge branch 'main' of https://github.com/Qiskit/qiskit-terra into de…

581e206

…precation-via-docstring

Better variable name

803492d

Merge branch 'deprecation-via-docstring' of https://github.com/Eric-A…

36b759e

…rellano/qiskit-terra into deprecation-via-docstring

Eric-Arellano and others added 4 commits March 6, 2023 12:18

Properly error when metadata line is the first line

d96714a

Tests feedback: don't use helper function and simplify instructions t…

aa93cca

…o generate tests

Merge branch 'main' into deprecation-via-docstring

d5f92cf

Merge branch 'main' of https://github.com/Qiskit/qiskit-terra into de…

c425e30

…precation-via-docstring

Eric-Arellano changed the title ~~Add deprecations automatically to functions' docstring~~ Add add_deprecation_to_docstring for docsite deprecation support Mar 8, 2023

Eric-Arellano requested review from HuangJunye and jakelishman March 9, 2023 21:45

1ucian0 reviewed Mar 10, 2023

View reviewed changes

qiskit/utils/deprecation.py Outdated Show resolved Hide resolved

Eric-Arellano and others added 2 commits March 10, 2023 08:43

Update qiskit/utils/deprecation.py

6541f9d

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

Merge branch 'main' into deprecation-via-docstring

bf28d6b

1ucian0 reviewed Mar 10, 2023

View reviewed changes

qiskit/utils/deprecation.py Outdated Show resolved Hide resolved

Update qiskit/utils/deprecation.py

54e1ebc

Co-authored-by: Luciano Bello <bel@zurich.ibm.com>

1ucian0 reviewed Mar 10, 2023

View reviewed changes

1ucian0 assigned jakelishman Mar 11, 2023

jakelishman reviewed Mar 13, 2023

View reviewed changes

Eric-Arellano added 3 commits March 13, 2023 12:25

Merge branch 'main' of https://github.com/Qiskit/qiskit-terra into de…

fef76a6

…precation-via-docstring

Add release note

7e21cc5

Merge branch 'deprecation-via-docstring' of https://github.com/Eric-A…

117f64e

…rellano/qiskit-terra into deprecation-via-docstring

Eric-Arellano commented Mar 13, 2023

View reviewed changes

jakelishman added Changelog: New Feature Include in the "Added" section of the changelog automerge and removed Changelog: None Do not include in changelog labels Mar 13, 2023

jakelishman approved these changes Mar 13, 2023

View reviewed changes

mergify bot merged commit 3005806 into Qiskit:main Mar 13, 2023

Eric-Arellano deleted the deprecation-via-docstring branch March 13, 2023 19:50

Eric-Arellano mentioned this pull request Mar 13, 2023

@deprecate_arguments and @deprecate_function add deprecation to docstring #9790

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `add_deprecation_to_docstring` for docsite deprecation support #9685

Add `add_deprecation_to_docstring` for docsite deprecation support #9685

Eric-Arellano commented Feb 28, 2023

qiskit-bot commented Feb 28, 2023

jakelishman commented Feb 28, 2023

coveralls commented Feb 28, 2023 •

edited

Loading

Eric-Arellano commented Mar 1, 2023 •

edited

Loading

jakelishman commented Mar 1, 2023 •

edited

Loading

Eric-Arellano commented Mar 1, 2023

HuangJunye left a comment

1ucian0 Mar 10, 2023

Eric-Arellano Mar 11, 2023

jakelishman left a comment

jakelishman Mar 13, 2023 •

edited

Loading

Eric-Arellano Mar 13, 2023

jakelishman Mar 13, 2023

jakelishman left a comment

jakelishman Mar 13, 2023

Eric-Arellano Mar 13, 2023

jakelishman Mar 13, 2023



		def add_deprecation_to_docstring(
		func: Callable, msg: str, *, since: Optional[str], pending: bool

Add add_deprecation_to_docstring for docsite deprecation support #9685

Add add_deprecation_to_docstring for docsite deprecation support #9685

Conversation

Eric-Arellano commented Feb 28, 2023

Summary

Details and comments

qiskit-bot commented Feb 28, 2023

jakelishman commented Feb 28, 2023

coveralls commented Feb 28, 2023 • edited Loading

Pull Request Test Coverage Report for Build 4408327792

💛 - Coveralls

Eric-Arellano commented Mar 1, 2023 • edited Loading

jakelishman commented Mar 1, 2023 • edited Loading

Eric-Arellano commented Mar 1, 2023

HuangJunye left a comment

Choose a reason for hiding this comment

1ucian0 Mar 10, 2023

Choose a reason for hiding this comment

Eric-Arellano Mar 11, 2023

Choose a reason for hiding this comment

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman Mar 13, 2023 • edited Loading

Choose a reason for hiding this comment

Eric-Arellano Mar 13, 2023

Choose a reason for hiding this comment

jakelishman Mar 13, 2023

Choose a reason for hiding this comment

jakelishman left a comment

Choose a reason for hiding this comment

jakelishman Mar 13, 2023

Choose a reason for hiding this comment

Eric-Arellano Mar 13, 2023

Choose a reason for hiding this comment

jakelishman Mar 13, 2023

Choose a reason for hiding this comment

Add `add_deprecation_to_docstring` for docsite deprecation support #9685

Add `add_deprecation_to_docstring` for docsite deprecation support #9685

coveralls commented Feb 28, 2023 •

edited

Loading

Eric-Arellano commented Mar 1, 2023 •

edited

Loading

jakelishman commented Mar 1, 2023 •

edited

Loading

jakelishman Mar 13, 2023 •

edited

Loading