featherduster icon indicating copy to clipboard operation
featherduster copied to clipboard

Clean up and standardize function help blurbs

Open unicornsasfuel opened this issue 7 years ago • 2 comments

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
"""

unicornsasfuel avatar Nov 17 '18 18:11 unicornsasfuel

Well, it seems this project is abandoned, unfortunately

q2dg avatar Mar 24 '21 22:03 q2dg

@q2dg While this project is abandoned, I (the original author) am maintaining a Python3-compatible fork of the cryptanalib module at https://github.com/unicornsasfuel/cryptanalib3. The FeatherDuster interface has not yet been recreated in Python3.

unicornsasfuel avatar Mar 24 '21 22:03 unicornsasfuel