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.

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

Code Cleanup #6

Open
hgn opened this issue Jul 10, 2017 · 1 comment
Open

Code Cleanup #6

hgn opened this issue Jul 10, 2017 · 1 comment

Comments

@hgn
Copy link
Member

hgn commented Jul 10, 2017

The code SHOULD be cleaned up. Most important: simplified. The intention of this repository is understanding, not to get the latest CPU cycle optimized. The code should read like a novel, somehow

  • So, no Python hacks, even if they are cool, it is important that Python Newcomers understand the code too
  • longer functions than 20 lines (soft limited) should be splitted into smaller functions with a nice name, if this is done correctly then no comments are required, or only some comments.
@reisub-de
Copy link
Contributor

It got a lot better in the meantime

TODO:

  • there are still some typehints missing
  • docstrings need improvement
  • module docstrings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants