search

JacobBumgarner / VesselVio

An open-source application for the analysis and visualization of segmented vasculature datasets
https://jacobbumgarner.github.io/VesselVio/
GNU General Public License v3.0
100 stars 22 forks source link

Create test backed tutorial #34

Closed TimothyStiles closed 2 years ago

TimothyStiles commented 2 years ago

Go has this really great built-in language feature called an example test

Basic idea is that you write your tutorials as tests that get rendered to your doc site on release. These help increase code coverage but more importantly will never let you release builds with out of date docs. Your CI/CD process will instead yell at you to fix it before you can release it.

I personally find tracking what needs to be updated in my docs impossible without this feature. Someone mentioned to me that there's a third-party thing in Python that does this and if there is such a thing I'd highly recommend it.

JacobBumgarner commented 2 years ago

Going to merge this into #31, which will encompass unit testing. Thanks @TimothyStiles !