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

Add requirement for non-plotting examples to be documented as ipython notebooks #276

Merged
merged 1 commit into from
Mar 16, 2015

Conversation

olgabot
Copy link
Collaborator

@olgabot olgabot commented Mar 16, 2015

Somewhat addresses the need for more examples as described here: #262 but not the visual examples, rather the day-to-day grind of dealing with dataframes and creating more dataframes.

  • Is it mergable?
  • Did it pass the tests?
  • If it introduces new functionality in scripts/ is it tested?
    Check for code coverage. To run code coverage on only the file you changed,
    for example flotilla/compute/splicing.py, use this command:
    py.test --cov flotilla/compute/splicing.py --cov-report term-missing flotilla/test/compute/test_splicing.py
    which will show you which lines aren't covered by the tests.
  • Do the new functions have descriptive
    numpydoc
    style docstrings?
  • If it adds a new plot, is it documented in the gallery?
  • Is it well formatted? Look at make pep8 and make lint output
  • Is it documented in the doc/releases/?
  • Was a spellchecker run on the source code and documentation after
    changes were made?

…otting features to be documented as ipython notebooks and added to the tutorial
olgabot added a commit that referenced this pull request Mar 16, 2015
Add requirement for non-plotting examples to be documented as ipython notebooks
@olgabot olgabot merged commit 8a5c59b into master Mar 16, 2015
@olgabot olgabot deleted the pr_checklist_examples branch May 8, 2015 02:59
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

Successfully merging this pull request may close these issues.

1 participant