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 #37

Open
2 of 8 tasks
banesullivan opened this issue Jan 27, 2019 · 0 comments
Open
2 of 8 tasks

Documentation #37

banesullivan opened this issue Jan 27, 2019 · 0 comments
Labels
docs These are issues pertaining to the docs pages help wanted

Comments

@banesullivan
Copy link
Member

banesullivan commented Jan 27, 2019

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
  • Finish the development guide:
    • 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 banesullivan added help wanted docs These are issues pertaining to the docs pages labels Jan 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs These are issues pertaining to the docs pages help wanted
Projects
None yet
Development

No branches or pull requests

1 participant