Skip to content

Misnamed parameter "include_significant" on method Task.get_param_names  #3167

@MartinHeimsoth-V

Description

@MartinHeimsoth-V

The classmethod Task.get_param_names has either a really confusingly misnamed parameter include_significant, or the implementation has a bug.
Example:

>>> class T(Task):
...     significant = Parameter(significant=True)
...     insignificant = Parameter(significant=False)
... 
>>> T.get_param_names()
['significant']
>>> T.get_param_names(include_significant=True)
['significant', 'insignificant']

So, I'd suggest to rename the parameter to include_insignificant (insignificant), or to change the implementation that on default it only returns the insignificant parameters, which would be weird though.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions