Skip to content

[doc] Indicate in the documentation that the @required_version decorator is deprecated #2211

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 5, 2021
Merged

[doc] Indicate in the documentation that the @required_version decorator is deprecated #2211

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
802f458
mentions deprecation warning on docs
rsarm Oct 4, 2021
2b1a787
Merge branch 'master' into deprecate-req-vers
Oct 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions reframe/core/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,10 @@ def required_version(*versions):
Examples of non-compliant version numbers are ``3.5`` and ``3.5-dev0``.
These should be written as ``3.5.0`` and ``3.5.0-dev.0``.

.. deprecated:: 3.5.0
Please set the ``require_version`` parameter in the class definition
instead.

'''
warn.user_deprecation_warning(
"the '@required_version' decorator is deprecated; please set "
Expand Down