Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docstrings, API docs #33

Open
briancurtin opened this issue Jun 10, 2019 · 3 comments
Open

Add docstrings, API docs #33

briancurtin opened this issue Jun 10, 2019 · 3 comments

Comments

@briancurtin
Copy link

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?

@cybergrind
Copy link
Member

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

@briancurtin
Copy link
Author

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?

@cybergrind
Copy link
Member

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants