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

Get test-suite to pass and documentation to build #2

Open
canismarko opened this issue Mar 6, 2017 · 0 comments
Open

Get test-suite to pass and documentation to build #2

canismarko opened this issue Mar 6, 2017 · 0 comments
Assignees

Comments

@canismarko
Copy link
Owner

canismarko commented Mar 6, 2017

This issue can be closed when you've pulled the latest source code and can get both the test-suite to pass and the documentation to build.

Instructions on all three of those things can be found here: https://scimap.readthedocs.io/en/latest/intro.html

The test-suite will make sure that you can run the existing code. The idea is that for every routine we write, we also write some code that calls that routine and checks that it does what we want or doesn't do what we don't want. That way we can feel confident that the python code we've written actually does what we think it does. An added benefit to having good tests is that when we make changes to the code, we can feel confident the we haven't broken something somewhere else, provided all the tests still pass.

If you run the test-suite and see "OK", then the tests all passed. You will see some "expected failures" as well; this is ok for now since we'll work on fixing those systematically. If you see any "failure" or "error" tests, the best plan is to paste the output into a gist and post a link to it as a comment below. Gists help avoid pasting large console output and cluttering up the conversation; they can be created here: https://gist.github.com/

The documentation is also something we should make sure we have up to date. Python includes a way to automatically build a website with the documentation; this gets uploaded to https://scimap.readthedocs.io whenever you push changes to the repository on github.

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

2 participants