Skip to content

docstrings missing default values #25

@wtgee

Description

@wtgee

I don't think you necessarily need this for the JOSS review, but I noticed while looking through it that none of the defaults are noted. I'm not sure if that is the particular docstring style you are using but seemed a bit odd to me. I noticed it in the context of some of the boolean options, but it also seems like thing such as the fscale_mad_factor=0.2 should be noted in the description.

Just a comment, feel free to change or not :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions