Skip to content

Document Every Function #2

@edvb

Description

@edvb

Every function should have a short doc string describing what it does.

Code should also be well commented. Any nontrivial line (or group of lines) should have a short explanation of what it does if the code is not self-explanatory, but more importantly, should always describe why it does it this way.

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