Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation guideline #192

Open
arcondello opened this issue Feb 25, 2022 · 0 comments
Open

Deprecation guideline #192

arcondello opened this issue Feb 25, 2022 · 0 comments

Comments

@arcondello
Copy link
Member

arcondello commented Feb 25, 2022

It would be useful for the docs to have our deprecation policy spelled out.

Also having an official "deprecation text" would be useful so we can be more consistent across Ocean. I was speaking with @JoelPasvolsky and we recommend something like

warnings.warn(
    "<feature> is deprecated since <package> X.Y.Z and will be removed in (X+2).0.0. "
    "Use <suggested alternative>."
    DeprecationWarning, stacklevel=...
)

in the code and

.. deprecated:: X.Y.Z

    <feature> will be removed in <package> (X+2).0.0. Use <suggested alternative>.

in the docstring. .. deprecated prepends Deprecated since version X.Y.Z: to the notice.

arcondello added a commit to arcondello/dimod that referenced this issue Mar 1, 2022
arcondello added a commit to arcondello/dimod that referenced this issue Mar 2, 2022
arcondello added a commit to dwavesystems/dimod that referenced this issue Mar 2, 2022
Also updates deprecation notes to match dwavesystems/dwave-ocean-sdk#192
Closes #1102
arcondello added a commit to dwavesystems/dimod that referenced this issue Mar 11, 2022
Also updates deprecation notes to match dwavesystems/dwave-ocean-sdk#192
Closes #1102
arcondello added a commit to dwavesystems/dimod that referenced this issue Mar 15, 2022
Also updates deprecation notes to match dwavesystems/dwave-ocean-sdk#192
Closes #1102
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant