PVGeo icon indicating copy to clipboard operation
PVGeo copied to clipboard

Documentation

Open banesullivan opened this issue 5 years ago • 0 comments

The documentation has fallen seriously behind. There needs to be updates to deprectated examples and an automated system needs to be developed for testing examples on the website.

To do:

  • [ ] Update docstrings for all algorithms and their methods
  • [ ] Use pytest to test any code examples in the docstrings
  • [ ] Create an example page for every algorithm
  • [ ] Fill out a Python example for every algorithm that leverages vtki for visualization
  • [x] Finish the development guide:
    • [x] Fill out examples on how to make common types of algorithms
  • [ ] Organize and add more to the resources section of the website
  • [ ] Fill out the testing suite to report coverage above 90% of the library

banesullivan avatar Jan 27 '19 19:01 banesullivan