Uppercase Qiskit in deprecation warnings
#13452
Conversation
|
One or more of the following people are relevant to this code:
|
| @@ -26,7 +26,7 @@ def deprecate_func( | |||
| since: str, | |||
| additional_msg: str | None = None, | |||
| pending: bool = False, | |||
| package_name: str = "qiskit", | |||
| package_name: str = "Qiskit", | |||
There was a problem hiding this comment.
The docstring for this argument indicates that it ought to be the PyPI package name. Assuming we want to make this change, we ought to update the docstring (and probably the arg name as well, e.g. package_description).
Do we use deprecate_func for packages other than Qiskit at this point? If not, perhaps we should just remove the argument altogether and hard-code "Qiskit" within.
There was a problem hiding this comment.
Yeah I stumbled over this too... I'd prefer not to change the argument name for backwards compatibility (and avoid using @deprecate_arg on this 😂), but we should change the description. Maybe
package_name: The name shown in the deprecation message (use e.g. the PyPI package name).
?
There was a problem hiding this comment.
Updated in 5dd8262, along with a test that setting package_name works as expected
Pull Request Test Coverage Report for Build 11917311198Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
|
Super minor comment: could it be |
Summary
This is a suggestion to change the default deprecation message to use
Qiskit 1.xinstead ofqiskit 1.x, since we commonly refer to this package in uppercase spelling.Details and comments
This means the message is changed e.g. from
to
The old format can still be obtained by explicitly setting
package_name="qiskit"in the deprecation decorators.