aiozk icon indicating copy to clipboard operation
aiozk copied to clipboard

Published 20 hours ago • verified publisher icon micro-fan

Add docstrings, API docs

Open briancurtin opened this issue 6 years ago • 3 comments

First off, I'm really liking the library, so thanks for putting out there!

As I'm using it, I'm finding it a little hard to navigate because there aren't docs or docstrings, so I'm looking through the source and tests to figure out how a lot of things work and sort of guessing at things.

Would you accept PRs if I added docs to this project?

briancurtin avatar Jun 10 '19 20:06 briancurtin

hi @briancurtin! sure, we will accept such PR's

cybergrind avatar Jun 10 '19 21:06 cybergrind

Ok cool! Once I get through more of what I'm working on I'll put some work in. Would you accept type annotations as well or should I leave those out?

briancurtin avatar Jun 11 '19 14:06 briancurtin

@briancurtin we still have 3.5 support so not all type annotations are supported in it. but if you put them in docstrings it would be great

cybergrind avatar Jun 11 '19 15:06 cybergrind