Skip to content

Describe the function preconditions in comments/docstrings #1945

@hwwhww

Description

@hwwhww

Issue

Pointed out by @franck44 and @protolambda, it would be more readable if we can more it clear of what are the preconditions of each function.

How to solve it

Add more detailed comments about the pre-conditions.

/cc @protolambda feel free to update this issue content. :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions