Missing a lot of docstrings

[LivInTheLookingGlass]

Going to open a separate branch to slowly work on this, probably while I'm on a plane

[prachipancholi]

Hey! I want to contribute, can you brief about the issue? @gappleto97

[LivInTheLookingGlass]

Sure! Basically I feel like if I am going to be providing methods that other people will have to do, I feel like I should be documenting it better than I have. That way they can be clear what they need to provide/should expect.

This puts me on three goals:

1. Get this codebase set up with Sphinx so the documentation is gathered in a way that's easy to read
2. Add docstrings to every function describing what it does, with what, and why, as well as what errors it could produce
3. Add type hints to everything reasonable

Once that stuff is done, I'll feel better about adding features that are more than just polish.

If you want to help out, probably the easiest way is to just give you commit access to another branch I'll call docs, then I'll get the Sphinx environment set up enough to start. I don't think I can really start on this for a few days, but I could get that much set up tonight.

[LivInTheLookingGlass]

And if you don't mind me asking, how'd you find this? I don't think I've shown it to many people yet, so I was pleasantly surprised

[prachipancholi]

And if you don't mind me asking, how'd you find this? I don't think I've shown it to many people yet, so I was pleasantly surprised

I got it from issuehub.io, where I was searching for my first contribution to Open Source

[LivInTheLookingGlass]

Okay, collab invite sent, docs branch made. Might need to add Sphinx's napoleon extension to make things pretty, but for now I'm just happy it makes a web page