Scripts

These scripts are available in the root of the repo. (Probably they should move someday?)

stylecheck

This script uses pep8 and pydocstyle to check that the current directory adheres to the styleguide requirements of this repository. If your local code passes stylecheck, there's no good reason that it should fail to pass Pull Request status checks! (If you're finding otherwise, get in touch!)

stylecheck uses some flags to handle some edge-cases and exceptions to the default styleguide rules, so it's a good idea to run this script specifically, in lieu of your usual styleguide checks.

generatedocs

This script uses pdoc to generate documentation. You probably don't need to use this — we'll handle this before any major version updates! Assuming your docstrings adhere to the stylecheck checks, you're in good shape, and your code's documentation will be copied to the main docs at http://docs.neurodata.io/ndio.