Add code documentation

[CaselIT]

Add documentation to the code

While adding the docs I've notices this strangeness in #3
I've not added this to the docs, but maybe it could be appropriate to add it?

[CaselIT]

I'm not sure why pypy coverage now fails, since I haven't changed any code

[vytas7]

Thanks, I'll take a look!

Not sure about that coverage miss either. -96 looks very odd, or at least I don't recognize it, coverage normally either list lines, or branches with ->.

[CaselIT]

indeed, line 96 is black..

[vytas7]

Maybe we can try asking a question on the coverage bugtracker...

I'll add some cosmetic edit, and keep the failed build for the reference.

[vytas7]

I've reported this on the coveragepy bug tracker.
Meanwhile, I'll check if Travis supports the newest PyPy3 (7.3.0), and if that could fix the issue.

[vytas7]

7.3.0 is unsupported, but I got an upgrade to 7.2.0, let's see...

[codecov-io]

Codecov Report

Merging #4 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master     #4   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           5      5           
  Lines         126    126           
  Branches       17     17           
=====================================
  Hits          126    126

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d0526c7...57d1135. Read the comment docs.

[CaselIT]

to the problem was the pypy version. how strange

[CaselIT]

friendly ping

[vytas7]

Do we really need to change this? I'm also a bit of control freak myself loving to make everything immutable (what can be made immutable), however, Python doc examples do use lists.

So IMHO better to stick to that.

[vytas7]

Thanks a lot for submitting this!
I'll probably need to polish this to my liking, but we'll need to actually build the docs first anyway.

[CaselIT]

Cheers 🍻