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

Add "experimental and untested" warnings to seismic.wavefd #319

Merged
merged 2 commits into from Sep 26, 2016

Conversation

Projects
None yet
1 participant
@leouieda
Member

leouieda commented Sep 23, 2016

Fixes #310

Added a warning message to the module docstring and a warnings.warn call that is triggered at import time. This way people know that this code is not for research purposes.

Checklist:

  • Make tests for new code (at least 80% coverage)
  • Create/update docstrings
  • Include relevant equations and citations in docstrings
  • Docstrings follow the style conventions
  • Code follows PEP8 style conventions
  • Code and docs have been spellchecked
  • Include new dependencies in doc/install.rst, requirements.txt, environment.yml, ci/requirements-conda.txt and ci/requirements-pip.txt.
  • Documentation builds properly (run cd doc; make locally)
  • Changelog entry (leave for last to avoid conflicts)

@leouieda leouieda added this to the 0.5 milestone Sep 23, 2016

@leouieda leouieda removed this from the 0.5 milestone Sep 26, 2016

@leouieda leouieda merged commit 54b584c into master Sep 26, 2016

3 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.007%) to 73.317%
Details

@leouieda leouieda deleted the wavefd-warning branch Sep 26, 2016

@leouieda leouieda referenced this pull request Sep 26, 2016

Merged

Test for SRTomo class #316

10 of 10 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment