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

Add file description and type hints to all files #2

Open
hc825b opened this issue Jul 29, 2019 · 0 comments
Open

Add file description and type hints to all files #2

hc825b opened this issue Jul 29, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@hc825b
Copy link
Member

hc825b commented Jul 29, 2019

All files should have a header briefly describe the functionality the Python module, i.e., the file.

All formal parameters and return value of all functions should be typed using typing module.
@hc825b hc825b added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hc825b