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

Doc Strings, Readme, and Drake #2

Open
paulsef opened this issue Jul 27, 2014 · 0 comments
Open

Doc Strings, Readme, and Drake #2

paulsef opened this issue Jul 27, 2014 · 0 comments

Comments

@paulsef
Copy link

paulsef commented Jul 27, 2014

Doc string ALL THE THINGS!!! It helps with readability. Whether it's a collaborator, coworker, or your future self, having a general description of what the script/class/function is supposed to do go a long way towards implementing the code.

I would recommend moving the stuff that's currently in the Readme to doc strings the respective script. Save the readme for a more detailed explanation of what it is you're trying to accomplish and a high level of how you did it.

Since it sounds like most of this needs to be done sequentially, you might want to check out Drake. It's Make for data let's you chain together various commands. So if C depends on B which depends on A, you can run Drake and it will run A --> B --> C. Also say if you changed B and only B, the next time you run Drake only B and C will be executed.

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

No branches or pull requests

1 participant