Skip to content
This repository was archived by the owner on Dec 22, 2021. It is now read-only.

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

Merged
leouieda merged 2 commits into
masterfrom
wavefd-warning
Sep 26, 2016
Merged

Add "experimental and untested" warnings to seismic.wavefd#319
leouieda merged 2 commits into
masterfrom
wavefd-warning

Conversation

@leouieda

@leouieda leouieda commented Sep 23, 2016

Copy link
Copy Markdown
Member

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
@leouieda leouieda deleted the wavefd-warning branch September 26, 2016 18:58
@leouieda leouieda mentioned this pull request Sep 26, 2016
10 tasks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant