Skip to content

Clean up and standardize function help blurbs #85

@unicornsasfuel

Description

@unicornsasfuel

Not all the functions in cryptanalib have help blurbs. Let's document all the functions and their expected return values and whatnot like so:

"""
Get integer nth roots.

:param x: The number to get the integer root of.
:param n: The root we want (e.g. 3 for cube root).
:return: The nth root of x rounded to an integer.
:rtype: long
"""

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

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions