PlasmaPy / PlasmaPy/PlasmaPy

Remove internal `@deprecated` decorator

Open
#3,301 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

revisit in 2026 status: on hold
Dominant language
Python
Stars
711
Forks
375
Avg merge
3h 2m
Merged PRs (30d)
8

Description

The internal plasmapy.utils.decorators.deprecation.deprecated decorator was deprecated in #3300 in favor of warnings.deprecated, which was added in Python 3.13 as a way to standardize deprecation.

Once PlasmaPy drops Python 3.12 support around October 2026, we should remove the internal @deprecated decorator and adopt @warnings.deprecated instead.

See also #3075.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with plasmapy.utils.decorators.deprecation.deprecated and review issue #3300 plus the usages of this decorator across the package. Check the Python-version support configuration and issue #3075 before changing anything. Done means the internal decorator and its usages are removed or migrated after Python 3.12 support ends, with the existing test suite passing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.