Skip to content

Documentation #37

Description

@banesullivan

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsThese are issues pertaining to the docs pageshelp wanted

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions