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

Include parameters type and documentation in method docstring #19

Open
f-f opened this issue Sep 30, 2017 · 0 comments
Open

Include parameters type and documentation in method docstring #19

f-f opened this issue Sep 30, 2017 · 0 comments
Labels
generation good first issue

Comments

@f-f
Copy link
Owner

f-f commented Sep 30, 2017

The parameters list for every method has some information about the type and the meaning of every parameter.
While the actual typechecking of the params should be covered in #10, here we should include both the type and documentation of the params in the method docstring.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
generation good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@f-f