Type annotations, doc-string re-formatting, code cleanup. #100
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mostly cosmetic changes or refactoring.
Type annotations are useful because
mypy
can be used to catch type errors as wellThat said, type annotation doesn't have to be done for every function.
If you use the PyCharm IDE, type annotations and auto-documentation works really well.
I also changed many imports of the form
from bindsnet.network import *
to be more explicit, i.e.,
from bindsnet.network import Network
so we're not reloading modules all over the place.