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

Documentation for walk_volume. #1

Merged
merged 4 commits into from
Feb 10, 2020
Merged

Documentation for walk_volume. #1

merged 4 commits into from
Feb 10, 2020

Conversation

cgyurgyik
Copy link

PR Summary

Provides documentation for walk_volume. This will ensure future maintainers are able to use this with less trouble than we had. Note that this still contains TODOs, since there are components I am still not sure of, and other additions that are necessary. Hopefully we can use this pull request as both a way to improve the documentation, and to improve our understanding of walk_volume.

PR Checklist

  • Code passes flake8 checker
  • New features are documented, with docstrings and narrative docs
  • Adds a test for any bugs fixed. Adds tests for new features.

Contains necessary TODOs.
@cgyurgyik cgyurgyik merged commit 2ad8460 into master Feb 10, 2020
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.

3 participants