Skip to content

Update docstring of @validate_quantities with checks_on_returnvalidations_on_return #2788

@namurphy

Description

@namurphy

In the docstring for @validate_quantities, some of the examples provide an argument to the checks_on_return parameter. We changed that at some point to be validations_on_return. We should change checks_on_returnvalidations_on_return in that docstring, and make sure it's not used in other places too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Plasma Lv0 | NoviceIssues that do not require knowledge of physicsPython Lv1 | BeginnerIssues that require some knowledge of Pythoneffort: minimalRequiring perhaps tens of minutesgood first issueGood first contributions for new contributorsplasmapy.utilsRelated to the plasmapy.utils subpackage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions