Added additional docstrings

[KasperDeBlieck]

Hi,

I created some docstrings for the util functions. It think it's a good first step to get familiar with the code base, and it might help others who are trying to do the same.
I only did those so far, because I wanted to get some feedback before investing to much time.

• Is it useful to invest the time, or will there be little added value. In that case, I'll just focus on understanding the code.
• Is the Google docstring format used the format we would like? (https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
• Is the quality of the docstrings what you expect it to be?

Of course, I'll probably get some stuff wrong along the way, so someone will have to spend some time on reviews as well.
Let me know if you want me to continue on the rest of the code.

Kind regards,
Kasper

[ornicar]

?

[ornicar]

Thanks but this is just a generator script generating puzzles in the background, I don't think it deserves that level of attention.

Additionally it seems to me that most of the comments are superfluous and add very little meaning that the function name and types don't already convey.