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

Create docstrings for most of the modules, functions and classes #10

Closed
tpiekarski opened this issue Jun 17, 2020 · 1 comment
Closed

Create docstrings for most of the modules, functions and classes #10

tpiekarski opened this issue Jun 17, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@tpiekarski
Copy link
Owner

tpiekarski commented Jun 17, 2020 •
edited
Loading

Overview

Add docstrings throughout the project.

Python is dynamically typed and so to know what is what there should be docstrings to indicate types of parameters and returning values. Next to this there could be explained some things in there as well, but staying up-to-date will demand some effort.

Links
@tpiekarski tpiekarski added the documentation Improvements or additions to documentation label Jun 17, 2020
@tpiekarski
Copy link
Owner Author

These docstrings for functions and modules can be considered noise.
After type hinting with Introduce function annotations (#17) introducing docstrings is mundane and redundant.

Dropping issue...

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tpiekarski