diff --git a/soitool/coder.py b/soitool/coder.py index 533e25995904ffd936170b028beb5071f8ce432d..bbc9e5664f368529cd5fac1b0e3b30e3385c44ac 100644 --- a/soitool/coder.py +++ b/soitool/coder.py @@ -6,8 +6,7 @@ import secrets def get_code(code_length, mode="ascii"): - """ - Generate a single random code. + """Generate a single random code. Parameters ---------- @@ -22,6 +21,11 @@ def get_code(code_length, mode="ascii"): ------ code : string The code + + Raises + ------ + ValueError + If mode param is neither of the accepted """ code = "" i = 0 @@ -45,8 +49,7 @@ def get_code(code_length, mode="ascii"): def get_code_set(count, code_length, mode="ascii"): - """ - Generate a set of unique, random codes. + """Generate a set of unique, random codes. Parameters ---------- @@ -74,8 +77,7 @@ def get_code_set(count, code_length, mode="ascii"): def get_code_length_needed(number_of_entries): - """ - Get code length needed to support one unique code for each entry. + """Get code length needed to support one unique code for each entry. Parameters ----------