Skip to content

Commit 083076c

Browse files
authored
Merge pull request #4273 from branfosj/simple_option
remove deprecated `descr` option for `simple_option`
2 parents 99f2472 + 9e0c680 commit 083076c

File tree

1 file changed

+4
-9
lines changed

1 file changed

+4
-9
lines changed

easybuild/base/generaloption.py

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1711,7 +1711,7 @@ class SimpleOption(GeneralOption):
17111711
PARSER = SimpleOptionParser
17121712
SETROOTLOGGER = True
17131713

1714-
def __init__(self, go_dict=None, descr=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
1714+
def __init__(self, go_dict=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
17151715
"""Initialisation
17161716
:param go_dict: General Option option dict
17171717
:param short_groupdescr: short description of main options
@@ -1740,18 +1740,13 @@ def __init__(self, go_dict=None, descr=None, short_groupdescr=None, long_groupde
17401740

17411741
super(SimpleOption, self).__init__(**kwargs)
17421742

1743-
if descr is not None:
1744-
# TODO: as there is no easy/clean way to access the version of the vsc-base package,
1745-
# this is equivalent to a warning
1746-
self.log.deprecated('SimpleOption descr argument', '2.5.0', '3.0.0')
1747-
17481743
def main_options(self):
17491744
if self.go_dict is not None:
17501745
prefix = None
17511746
self.add_group_parser(self.go_dict, self.descr, prefix=prefix)
17521747

17531748

1754-
def simple_option(go_dict=None, descr=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
1749+
def simple_option(go_dict=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
17551750
"""A function that returns a single level GeneralOption option parser
17561751
17571752
:param go_dict: General Option option dict
@@ -1765,5 +1760,5 @@ def simple_option(go_dict=None, descr=None, short_groupdescr=None, long_groupdes
17651760
17661761
the generated help will include the docstring
17671762
"""
1768-
return SimpleOption(go_dict=go_dict, descr=descr, short_groupdescr=short_groupdescr,
1769-
long_groupdescr=long_groupdescr, config_files=config_files)
1763+
return SimpleOption(go_dict=go_dict, short_groupdescr=short_groupdescr, long_groupdescr=long_groupdescr,
1764+
config_files=config_files)

0 commit comments

Comments
 (0)