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

Better doc strings #54

Open
ivirshup opened this issue May 10, 2022 · 0 comments
Open

Better doc strings #54

ivirshup opened this issue May 10, 2022 · 0 comments
Milestone
v0.2.0

Comments

@ivirshup
Copy link
Member

We should be demonstrating more features in the docs.

In particular, I think we should be demonstrating what a fully featured docstring looks like. This means adding type hints, parameter docs, and ideally examples.
@grst grst added this to the v0.2.0 milestone Jul 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v0.2.0
Development

No branches or pull requests
2 participants
@grst @ivirshup