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.

Sign up for GitHub

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

Jump to bottom

Improve docs and readme #15

Open
lgeiger opened this issue May 30, 2019 · 2 comments
Open

Improve docs and readme #15

lgeiger opened this issue May 30, 2019 · 2 comments
Labels
documentation Issues related to documentation good first issue Good for newcomers

Comments

@lgeiger
Copy link
Member

lgeiger commented May 30, 2019

Docs are currently really bare-bones and only consist of an example. We should improve that.
@lgeiger lgeiger added good first issue Good for newcomers documentation Issues related to documentation labels May 30, 2019
@HtHuanChen
Copy link

HtHuanChen commented Jun 19, 2019 •
edited
Loading

And no annotation, can't call __doc__ . (._.)

@lgeiger
Copy link
Member Author

lgeiger commented Jun 19, 2019

And no annotation, can't call doc . (._.)

Fair point. Are you interested in sending a PR to add some docstrings?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Issues related to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lgeiger @HtHuanChen