Modularised drugz code #5
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…adability, code comprehension, and the ability to unit test the code. Logging module was added to enable more configuration of error logging. Python csv module was used to standardise line formatting at a file level. Commenting and doc strings added to help code comprehension.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hi guys,
I know this is a bit of a major rewrite, but I think it makes your absolutely excellent tool a bit more readable/understandable (and maybe even a little bit easier for the community to develop on).
I tested the output from the original version of drugz and mine and they produced identical results, with very similar performance metrics for three separate inputs, but that obviously isn't exhaustive.
The documentation I've written is based on what I could understand from the code, but it may not be entirely accurate so if you do decide you like the changes please check everything I've written comment/docstring wise.
Anyway, big fan of your work, so even if you just end up ignoring this thanks for producing great open source analysis tools!
Commit log:
A rewrite of the drugz code into more discrete units of work to improve readability, code comprehension, and the ability to unit test the code.
Logging module was added to enable more configuration of error logging.
Python csv module was used to standardise line formatting at a file
level.
Commenting and doc strings added to help code comprehension.